/substack/posts/search

POST /api/substack/posts/search

Price: 10 credits

List or search posts within a Substack publication by subdomain or custom domain. Returns post list items ordered by sort (new/top/community), optionally filtered by a keyword: id, alias (slug), title, subtitle, preview text, audience, type, published_at, reaction_count, comment_count, and cover image.

How to use it

List or keyword-search posts of a single Substack publication. publication is the publication's subdomain (e.g. platformer) or custom domain (e.g. thefp.com). Set search to filter posts by a keyword, omit it to get the plain feed. sort orders the feed (new/top/community). Each item is a post projection (id, alias, title, subtitle, preview_text, audience, type, published_at, reaction_count, comment_count, image) — use substack/posts with the alias to fetch the full post body.

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)
• count integer required — Max number of posts to return (min: 1)
• search string nullable — Keyword to filter posts within the publication
• sort string — Ordering of the publication feed (default: "new"; one of: "new", "top", "community")

Response

• @type string (default: "SubstackPostListItem")
• id integer required
• alias string nullable
• subtitle string nullable
• preview_text string nullable
• audience string nullable (one of: "only_paid", "only_free", "everyone", "founding")
• type string nullable (one of: "newsletter", "podcast", "thread", "video", "restack")
• published_at string nullable
• canonical_url string nullable
• publication_id integer nullable
• reaction_count integer nullable
• comment_count integer nullable
• image string 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.