Skip to content

Subreddit Details

GET /v1/reddit/subreddit/details

Retrieves metadata about a subreddit by name or URL. The subreddit name must be case-sensitive. Returns display_name, description, subscribers, weekly_active_users, weekly_contributions, rules, icon_img, header_img, advertiser_category, submit_text, and created_at.

Authentication

All requests require the x-api-key header. Get your key at scrapecreators.com.

Query Parameters

NameTypeRequiredDescriptionExample
subredditstringnoSubreddit name. MUST be case sensitive. So 'AskReddit' not 'askreddit'.AskReddit
urlstringnoSubreddit URLhttps://www.reddit.com/r/AbsoluteUnits/

Example Request

curl

bash
curl 'https://api.scrapecreators.com/v1/reddit/subreddit/details' \
  -H 'x-api-key: $SCRAPECREATORS_API_KEY'

Node / TypeScript

js
const params = new URLSearchParams({  });
const res = await fetch(`https://api.scrapecreators.com/v1/reddit/subreddit/details?${params}`, {
  headers: { 'x-api-key': process.env.SCRAPECREATORS_API_KEY }
});
const data = await res.json();
console.log(data);

Python

python
import os, requests
r = requests.get(
    'https://api.scrapecreators.com/v1/reddit/subreddit/details',
    headers={'x-api-key': os.environ['SCRAPECREATORS_API_KEY']},
    params={},
)
r.raise_for_status()
print(r.json())

CLI

bash
scrapecreators reddit subreddit-details --help

Example Response

json
{
  "success": true,
  "credits_remaining": 33950256,
  "subreddit_id": "t5_a7wuv",
  "display_name": "AbsoluteUnits",
  "weekly_active_users": 1428398,
  "weekly_contributions": 8923,
  "rules": "#ABSOLUTE UNITS\n\n---\n\n    Be in awe at the size of these lads\n\n---\n\n###[Check out our deep, well-reflected definitions of an absolute unit.](https://www.reddit.com/r/AbsoluteUnits/wiki/index)  ",
  "description": "Absolute Unit : an Animal or Public Figure, who is larger than we should normally expect.",
  "header_img": null,
  "icon_img": "https://styles.redditmedia.com/t5_a7wuv/styles/communityIcon_t3cspt08bl681.png?width=128&frame=1&auto=webp&s=6f7e59ccf1724bd6c8b3e0d2840c9b21297102c3",
  "subscribers": 1923642,
  "advertiser_category": "",
  "created_at": "2018-01-05T10:35:24.000Z",
  "submit_text": ""
}

Credits

Most ScrapeCreators endpoints consume 1 credit per successful response. Some heavier endpoints (transcripts, AI-driven enrichment, ad detail lookups) may cost more. Check GET /v1/credit-balance for your remaining balance.

Errors

StatusMeaningAction
200Success.Use the JSON payload.
400Invalid or missing parameter.Verify required parameters and value format.
401Missing or invalid x-api-key.Pass a valid API key in the header.
402Out of credits.Top up at scrapecreators.com or wait for plan reset.
404Resource not found or private.Confirm the handle, URL, or id and that the resource is public.
429Rate limited.Backoff and retry with exponential delay.
500Server error or upstream platform failure.Retry with backoff; report persistent errors to support.