/substack/posts/comments

POST /api/substack/posts/comments

Price: 10 credits

Get comments of a Substack post by publication (subdomain or custom domain) and numeric post id. Returns the threaded comment tree: each comment has id, text, author, created_at, depth, parent_id, reaction_count and reactions, restack_count, reply_count, and nested replies.

How to use it

Get comments on a Substack post. Identity is (publication, post_id). publication is the publication's subdomain (e.g. platformer) or custom domain (e.g. thefp.com); post_id is the numeric post id (the id field returned by substack/posts, not the slug). Each item is a top-level comment with nested replies (a threaded tree): id, text, author, created_at, depth, parent_id, reaction_count, reactions, restack_count, reply_count, and replies. Comments may be empty when a publication restricts them to subscribers.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• publication string required — Substack publication subdomain or custom domain (examples: "thefp.com", "newsletter.pragmaticengineer.com", "platformer"; minLength: 1)
• post_id integer required — Numeric post id (the id field of a Substack post) (examples: 201460006; >: 0)
• count integer required — Max number of top-level comments to return (min: 1)

Response

• @type string (default: "SubstackComment")
• id integer required
• text string nullable
• author object nullable
  • @type string (default: "SubstackCommentAuthor")
  • id integer nullable
  • name string nullable
  • handle string nullable
  • image string nullable
• created_at string nullable
• edited_at string nullable
• depth integer (default: 0)
• parent_id integer nullable
• reaction_count integer nullable
• reactions object (default: {})
  • * integer
• restack_count integer nullable
• is_pinned boolean (default: false)
• is_deleted boolean (default: false)
• reply_count integer (default: 0)
• replies array (default: [])

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 — Post not found, or the publication is not a valid Substack publication 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.