scraper
Back to API docs

Overview

  • Overview

APIs

  • POSTPost
  • POSTSearch
  • POSTSubreddit
  • POSTUser Posts
  • POSTUser Comments
  • POSTCommunity

Reddit Community

1 credit

Discover subreddits by keyword.

POST/api/v1/tools/reddit/community

Parameters

querystringrequired

Keyword to find subreddits by (e.g. "machine learning").

maxItemsnumber

Maximum number of subreddits to return. Defaults to 25. Upper bound is determined by your plan.

includeNsfwboolean

Include over-18 communities. Defaults to true.

fieldsstring[]

Subreddit fields to include. Defaults: id, name, namePrefixed, title, publicDescription, subscribers, over18, url, createdAt. Use ["*"] for all fields, including icons, banners, and submission settings.

Response Schema

dataobject

Community discovery result

subredditsobject[]

Matching subreddits in relevance order. Fields depend on the fields parameter; defaults listed below.

countnumber

Number of subreddits returned

truncatedboolean

True when the request budget stopped the walk before maxItems was met.

metaobject

Request metadata

toolstring

Tool name (reddit-community)

creditsUsednumber

Credits consumed (1)

requestIdstring

Unique request ID

Request

curl -X POST https://scraper.run/api/v1/tools/reddit/community \
-H "Authorization: Bearer sc_live_..." \
-H "Content-Type: application/json" \
-d '{
"query": "machine learning",
"maxItems": 10
}'

Response Example

{
"data": {
"subreddits": [
{
"id": "2r3gv",
"name": "MachineLearning",
"namePrefixed": "r/MachineLearning",
"title": "Machine Learning",
"publicDescription": "Beginners please see learnmachinelearning",
"subscribers": 3000000,
"over18": false,
"url": "https://www.reddit.com/r/MachineLearning/",
"createdAt": "2009-07-29T15:20:00.000Z"
}
],
"count": 1,
"truncated": false
},
"meta": {
"tool": "reddit-community",
"creditsUsed": 1,
"requestId": "req_abc123"
}
}