LurkAPI
Docs · Subreddit details

Subreddit details

A community's size, activity, description, rules and images.

1 credit per callFresh within 1 hourMCP tool: reddit_subreddit_details
GEThttps://api.lurkapi.com/v1/reddit/subreddit/details

Example responseView as markdown

When to use this

Use it to size up a community before posting: weekly visitors and contributions, rules and description. There's no subscriber count (reddit.com no longer shows it); weekly_active_users is the closest measure.

Stats and settings for one subreddit: the numbers reddit.com shows on the community page, numbered rules, icon, banner and creation date. Pass subreddit or a Reddit url.

Unknown or private subreddits return 404 not_found.

Parameters

All parameters go in the query string.

ParameterDescription
subreddit
stringoptional
Subreddit name (e.g. marketing) or URL. Required unless you pass url.
Example
marketing
url
stringoptional
Any Reddit URL containing /r/<name>, e.g. https://www.reddit.com/r/marketing/.

Example request

Replace YOUR_API_KEY with your key, or set LURKAPI_KEY for the code. Get a free key.

Language

Example response

A real response from this endpoint, captured from the live API and trimmed to a couple of items. Strings over 96 characters (mostly signed media URLs) are cut short and end in ….

Show the example response (1 KB)
{
  "success": true,
  "credits_remaining": 994,
  "credits_charged": 1,
  "subreddit_id": "t5_2qhmg",
  "display_name": "marketing",
  "weekly_active_users": 70309,
  "weekly_contributions": 965,
  "rules": "1. Advertising, Self-Promotion, & Spam (Permanent Ban)\nIf you want to ad…",
  "description": "For marketing communications + advertising industry professionals to dis…",
  "header_img": "https://styles.redditmedia.com/t5_2qhmg/styles/bannerBackgroundImage_y1x…",
  "icon_img": "https://styles.redditmedia.com/t5_2qhmg/styles/communityIcon_amdb6rj8w5p…",
  "created_at": "2008-03-23T18:17:57.000Z"
}

Response fields

Every field of a successful response. [] marks a list: a[].b is the b of each item in a. nullable fields can be null; optional fields can be missing.

Show all 12 fields
FieldTypeDescription
successtrueAlways true here; errors have success: false.
credits_remainingnumberYour balance after this call. On anonymous playground calls: free tries left today.
credits_chargednumberCredits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1).
subreddit_idstringFullname, t5_….
display_namestringName with Reddit's capitalization.
descriptionstringThe public one-paragraph description.
rulesstringCommunity rules as numbered plain text: "1. Title\nDetails\n\n2. …".
weekly_active_usersnumbernullableWeekly visitors, as shown on the community page.
weekly_contributionsnumbernullablePosts plus comments in the last week.
icon_imgstringnullableCommunity icon URL; null if none.
header_imgstringnullableBanner image URL; null if none.
created_atstringWhen the subreddit was created, ISO 8601.

Caching and freshness

Responses are cached for up to 1 hour, so a repeat call within that window can return the same data. It still costs 1 credit.

Errors

Errors return { success: false, error, code, docs } with the HTTP status below. Validation errors, 401/402/429 rejections and 5xx failures are free; not_found is charged (how charging works). All error codes.

StatusCodeMeaning
401missing_api_keyNo API key. Send it in the x-api-key header.
401invalid_api_keyThe key is unknown or was revoked.
402insufficient_creditsNot enough credits for this call. Buy a pack or wait for tomorrow's top-up.
404not_foundThe endpoint, or the thing you asked for (ad, post, subreddit), doesn't exist. Charged when the platform was checked.
405method_not_allowedEndpoints take GET with query params.
429rate_limitedToo many calls at once. Wait for the retry-after seconds, then retry.
500internal_errorSomething broke on our side. Retry; 5xx errors are free.
502upstream_errorThe platform didn't give a usable answer. Retry; 5xx errors are free.
503upstream_busyAll our connections to the platform are busy. Retry in a few seconds; 5xx errors are free.
504upstream_timeoutThe platform took over 30 seconds to answer. Retry; timeouts are free.

Use it in Claude

Once LurkAPI is connected to Claude, this endpoint is the reddit_subreddit_details tool. Ask in plain English, for example:

Ask Claude
Use LurkAPI's reddit_subreddit_details with subreddit "marketing" and summarize what you find.

Claude calls reddit_subreddit_details with arguments like these, and each call costs 1 credit:

Tool arguments
{
  "subreddit": "marketing"
}

Tool results skip nulls and empty lists to save tokens.