reddit

Search within a subreddit

Searches for posts within a specific subreddit. Returns matching posts with titles, scores, comment counts, permalinks and, where the row carries them, the post body at ext.selftext, the author's avatar, structured media, the upvote ratio, the flair and Reddit's own content language. One result page is assembled from more than one index: the first rows are the community's own relevance ranking, unchanged and in its original order, and further rows are appended from Reddit's search index scoped to the same community. A page holds up to 25 posts and the exact count varies between calls, so read the length of items rather than assuming a number — pages of about 7 are what you get when only the first index answers. Because the page spans two indexes, three leaves are reported for only part of it and are null on the rest: post.flags.spoiler, post.engagement.shares and post.engagement.saves. A null there means the index that returned that row does not report the field, never that the value is false or zero, so do not aggregate over them. Omitting query returns the community listing from the first index alone, because Reddit's scoped search needs terms to match. include_body=true is still accepted and rarely needed now that bodies arrive on the rows themselves: it costs 1 extra credit per post that actually comes back with a body, up to 25 per page, and refunds every credit it does not spend. Ranking is a voice-of-customer sweep rather than precision retrieval, so expect some off-topic matches on short queries, and use quoted phrases to tighten them.

get/reddit/subreddit/search

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/reddit/subreddit/search
  • Auth: API key in header x-api-key

Query parameters

subredditstring required

Subreddit name (e.g. 'Fitness', not 'r/Fitness' or a full URL)

querystring

Search query to find matching content

sort'relevance' | 'hot' | 'top' | 'new' | 'comments'

Sort order. For posts/media: relevance, hot, top, new, comments. For comments: relevance, top, new

timeframe'all' | 'year' | 'month' | 'week' | 'day' | 'hour'

Only return posts from this window. Applied on sort=relevance, sort=top and sort=comments. It has no effect with sort=new, which is already ordered newest-first and returns recent posts regardless.

cursorstring

Cursor to get more results. Get 'cursor' from previous response.

include_bodyboolean

Set to true to include each post's body (selftext) on the search page. 1 extra credit per post that comes back with a body, unused credits refunded. Link posts have no body, so they are looked up and not charged for.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept. published_after, start_date, from_date, publish_time (yesterday, this-week, this-month, last-3-months, last-6-months) and max_age_days are accepted and applied as since.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept. published_before, end_date and to_date are accepted and applied as until.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "reddit",
  "endpoint": "/v1/reddit/subreddit/search",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.