/reddit/search/posts

POST /api/reddit/search/posts

Price: 9 credits

Reddit Search Posts

How to use it

Search Reddit posts by query. Supports sort (relevance, hot, top, new, comments) and time filters. By default the query terms are not all required: Reddit's own ranking can return a post missing one of the words, so a non-empty response is not proof every word matched. To require every word, either join them with AND, prefix each with +, or quote the phrase (e.g. 'bitcoin AND halving', '+bitcoin +halving', '"bitcoin halving"') — Reddit itself then returns only posts containing all of them, empty if none do. Alternatively set match_all_words=true to keep only results whose title or text contains every query word, at the cost of dropping posts that use a synonym, abbreviation or a different word form (plural/stem) for one of the terms. Relevant results for a broad query can rank beyond a small count — raise count to reach them.

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: "crypto bitcoin"; minLength: 1)
• sort string — Result sorting (default: "relevance"; one of: "relevance", "hot", "top", "new", "comments")
• time_filter string — Time window for results (default: "all"; one of: "all", "year", "month", "week", "day", "hour")
• count integer required — Max result count (examples: 20; min: 1)
• match_all_words boolean — Keep only results whose title or text contains every word of the query (case-insensitive; a quoted phrase counts as one word; subreddit:/author:/self:/site: terms are not checked). Returns an empty list rather than a loosely related result when nothing qualifies. (default: false)

Response

• @type string (default: "RedditPost")
• id string required
• title string required
• url string required
• author object nullable
  • @type string (default: "RedditAuthor")
  • id string required
  • name string required
• subreddit string nullable
• subreddit_id string nullable
• created_at integer nullable
• vote_count integer nullable
• comment_count integer nullable
• post_type string nullable
• content_url string nullable
• text string nullable
• thumbnail_url string nullable
• nsfw boolean (default: false)
• spoiler boolean (default: false)
• upvote_ratio number nullable
• flair_text string nullable
• stickied boolean (default: false)
• locked boolean (default: false)
• edited_at integer nullable
• image string nullable
• gallery array (default: [])
  • @type string (default: "RedditGalleryItem")
  • image string required
  • width integer nullable
  • height integer nullable
• video object nullable
  • @type string (default: "RedditVideo")
  • fallback_url string required
  • hls_url string nullable
  • width integer nullable
  • height integer nullable
  • duration integer nullable

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.