/substack/publications

POST /api/substack/publications

Price: 10 credits

Get a Substack publication by subdomain or custom domain: name, alias, description, author, language, type, created_at, logo and cover image, subscriber count, payment state, podcast details, and subscription plans.

How to use it

Fetch a single Substack publication. Identity is the publication's subdomain (e.g. lenny) or custom domain (e.g. thefp.com). Returns one item with id, name, alias (subdomain), description, author (name/handle/bio/image), language, type (newsletter/podcast), created_at, first_post_date, image (logo), cover_image, free_subscriber_count, payments_state, podcast fields, and plans (price/interval/currency).

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", "lenny", "newsletter.pragmaticengineer.com"; minLength: 1)

Response

• @type string (default: "SubstackPublication")
• id integer required
• name string nullable
• alias string nullable
• custom_domain string nullable
• hostname string nullable
• base_url string nullable
• description string nullable
• copyright string nullable
• language string nullable
• type string nullable (one of: "newsletter", "podcast")
• homepage_type string nullable
• created_at string nullable
• first_post_date string nullable
• image string nullable
• logo_wide string nullable
• cover_image string nullable
• author_id integer nullable
• author_name string nullable
• author_handle string nullable
• author_bio string nullable
• author_image string nullable
• twitter_screen_name string nullable
• free_subscriber_count integer nullable
• subscriber_count_label string nullable
• payments_state string nullable
• is_personal_mode boolean nullable
• is_explicit boolean nullable
• is_invite_only boolean nullable
• is_community_enabled boolean nullable
• has_posts boolean nullable
• has_podcast boolean nullable
• has_recommendations boolean nullable
• has_community_content boolean nullable
• podcast_enabled boolean nullable
• podcast_title string nullable
• podcast_description string nullable
• podcast_byline string nullable
• podcast_feed_url string nullable
• podcast_image string nullable
• plans array (default: [])
  • @type string (default: "SubstackPublicationPlan")
  • id string nullable
  • nickname string nullable
  • amount integer nullable
  • currency string nullable
  • interval string nullable
  • interval_count integer nullable
  • is_active boolean 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 — Publication not found, or the input 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.