/reddit/posts/comments

POST /api/reddit/posts/comments

Price: 18 credits

Get Reddit Post Comments

How to use it

Get comments on a Reddit post by URL or path. Returns a threaded comment tree with scores, nested to their real depth. Optional max_comments caps the total. A large thread is returned in part: the top-level comments returned come with their reply trees, and some top-level comments of a large thread are not included. The X-Stop-Reason header says why the response ended: thread-exhausted (the whole thread is returned), surface-limit (everything available for this thread is returned and the rest is not), max-comments, time-budget or upstream-unavailable; for the last three, pass the X-Next-Cursor header back as cursor with the same post_url to get the rest.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• post_url string required — Reddit post URL or path (examples: "/r/DogAdvice/comments/1o2g2pq/i_think_i_need_to_rehome_my_dog/"; minLength: 1)
• max_comments integer nullable — Max total comments to return, including nested replies (not just top-level threads). Omit for the default (700); a higher value returns more of the thread until it is reached, everything available for the thread is returned, or the request is close to its own timeout. Capped at 5000. (examples: 700; min: 1; max: 5000)
• cursor string nullable — The X-Next-Cursor header of a previous response for the same post. Returns the next part of the thread: comments not returned before, each reply nested under its parent when the parent is in the same part, otherwise listed at the top level with its parent_id. (minLength: 1)

Response

• @type string (default: "RedditComment")
• id string required
• author object nullable
  • @type string (default: "RedditAuthor")
  • id string required
  • name string required
• text string nullable
• score integer nullable
• created_at integer nullable
• depth integer (default: 0)
• parent_id string nullable
• is_submitter boolean (default: false)
• is_deleted boolean (default: false)
• permalink string nullable
• edited_at integer nullable
• distinguished string nullable
• controversiality integer nullable
• replies_count integer (default: 0)
• replies array (default: [])

Errors

• 422 — The cursor is malformed or belongs to a different post. 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 — Post not found. Verify the URL or path. 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.