reddit
prism

Reddit VoC sweep: one keyword → threads across all of Reddit with subreddit attribution and top comments inline.

Runs reddit/search, expands the top N threads' comments in parallel (capped 15/thread), and rolls up which subreddits are talking. Each thread carries its comments at threads[].top_comments (the include parameter names this block comments; the field on the response is top_comments). Each rollup row is { name, subscribers, weekly_active_users, thread_count, tone }. subscribers is how many accounts have joined the community and weekly_active_users is how many took part in the last week. The second is NOT a subset of the first, because Reddit does not require joining to post or comment: measured on r/keyboards the weekly figure (188,869) is HIGHER than the subscriber count (147,416), while on r/technology it is far lower. Read them as two independent signals, size against liveliness, and never as a ratio. Both are filled from the same source as /v1/reddit/subreddit/details and inherit its behaviour, so on a small share of rows one or both can be null while the rest of the row is unchanged. tone is one LLM label per community and degrades to null with a _warnings line rather than a silent blank. Returns sync JSON or a typed SSE stream that emits each thread as its comments land. Metered at 1 credit per search page + 1 credit per successfully-expanded thread (minimum 5); a failed thread isn't billed and the unused thread ceiling is refunded. subreddit= scopes the sweep to one community. The next_cursor resumes the search. Honest note: Reddit search is the slowest social search on the API (a 10 to 12s median, with a tail past 30s, so allow a 60s client timeout) and relevance is loose: a VoC sweep, not precision ranking.

get/reddit/omni-search

Request

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

Query parameters

querystring required

Keyword or phrase to sweep across Reddit.

threadsinteger

How many top threads to expand comments for (1-8, default 8).

sort'relevance' | 'new' | 'top' | 'comment_count'

Search sort order (relevance | new | top | comment_count).

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

Time window for the search (all | day | week | month | year).

subredditstring

Scope the sweep to one subreddit (bare name, no r/ prefix).

cursorstring

Opaque cursor from a prior response's next_cursor to page deeper.

includestring

CSV subset of subreddits,comments (default both). The comments block is returned as threads[].top_comments.

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/omni-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"
    }
  }
}

Changes

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