/reddit/search/comments

POST /api/reddit/search/comments

Price: 15 credits

Reddit Search Comments

How to use it

Search Reddit comments across all subreddits by keyword. Sort by relevance, top or new. A query reaches roughly 170-220 matching comments at most. time_filter keeps comments created within the window: with sort=new it returns everything in the window up to count, with relevance or top it keeps only the matches among those ranked results, so a short window can return few or none. Each comment carries its post id, title and URL; get the whole thread with reddit/posts/comments.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search query (examples: "bitcoin halving"; minLength: 1)
• sort string — Result sorting (default: "relevance"; one of: "relevance", "top", "new")
• time_filter string — Only comments created within this window before now (default: "all"; one of: "all", "year", "month", "week", "day", "hour")
• count integer required — Max result count (examples: 25; min: 1; max: 200)

Response

• @type string (default: "RedditSearchComment")
• id string required
• url string required
• text string nullable
• author object nullable
  • @type string (default: "RedditAuthor")
  • id string required
  • name string required
• is_deleted boolean (default: false)
• score integer nullable
• created_at integer nullable
• edited_at integer nullable
• parent_id string nullable
• post_id string nullable
• post_title string nullable
• post_url string nullable
• subreddit string nullable
• subreddit_id string nullable
• is_submitter boolean (default: false)
• distinguished string nullable
• controversiality integer nullable
• stickied boolean (default: false)
• locked boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.