Search Substack publications Search Substack publications and their metadata.
GET /v1/substack/search/publications
x-api-key* string header
API key (`sfk_...`)
query* string required query
Text to search publications for.
min 1 chars · max 200 chars
page integer optional query
Page number, 0 to 100,000; twenty publications a page. Only pages 0 to 3 have results, so a page past 3 returns an empty list with `hasMore: false`.
≥ 0 · ≤ 100000
Response fields 133 Expand all Collapse all Collapse all Endpoint-specific response payload.
The query that was searched.
data . publications [] . id
integer
Numeric publication id.
data . publications [] . name
string nullable
The publication's name.
data . publications [] . subdomain
string nullable
The publication's Substack subdomain.
data . publications [] . customDomain
string nullable
The publication's custom domain, when it has one.
data . publications [] . apexDomain
string nullable
The publication's apex domain, when it has one.
data . publications [] . url
string nullable
The publication's canonical base URL.
data . publications [] . host
string nullable
The host its pages are served from.
data . publications [] . description
string nullable
The publication's description.
data . publications [] . language
string nullable
The publication's language code.
data . publications [] . kind
string nullable
`newsletter`, `podcast` or Substack's own type.
data . publications [] . createdAt
string nullable
ISO 8601 timestamp, or null when Substack does not publish one.
data . publications [] . firstPostAt
string nullable
ISO 8601 timestamp, or null when Substack does not publish one.
data . publications [] . hasPosts
boolean nullable
Whether the publication has posts.
data . publications [] . isExplicit
boolean nullable
Whether the publication is marked explicit.
data . publications [] . isInviteOnly
boolean nullable
Whether the publication is invite-only.
data . publications [] . isFlagged
boolean nullable
Whether the publication is flagged.
data . publications [] . noIndex
boolean nullable
Whether search engines are asked not to index it.
data . publications [] . isOnSubstack
boolean nullable
Whether the publication is hosted by Substack.
data . publications [] . commentsEnabled
boolean nullable
Whether comments are enabled.
data . publications [] . notesEnabled
boolean nullable
Whether Notes are enabled.
data . publications [] . defaultCommentSort
string nullable
The default comment order.
data . publications [] . annualDisabled
boolean nullable
Whether annual plans are disabled.
data . publications [] . monthlyDisabled
boolean nullable
Whether monthly plans are disabled.
data . publications [] . paymentsState
string nullable
The publication's payments state.
data . publications [] . freeTrialEnabled
boolean nullable
Whether a free trial is offered.
data . publications [] . pausedUntil
string nullable
ISO 8601 timestamp, or null when Substack does not publish one.
data . publications [] . emailBannerUrl
string nullable
The email banner image URL.
data . publications [] . copyright
string nullable
The copyright line the publication prints.
data . publications [] . logoUrl
string nullable
The publication's logo URL.
data . publications [] . wideLogoUrl
string nullable
The publication's wide logo URL.
data . publications [] . coverImageUrl
string nullable
The publication's cover image URL.
data . publications [] . foundingPlanName
string nullable
The name of the founding-member plan.
data . publications [] . hasRecommendations
boolean nullable
Whether the publication recommends others.
data . publications [] . benefits object
The benefit lists for each subscription tier.
data . publications [] . benefits . free array
Benefits for free subscribers.
data . publications [] . benefits . free []
string optional
data . publications [] . benefits . paid array
Benefits for paid subscribers.
data . publications [] . benefits . paid []
string optional
data . publications [] . benefits . founding array
Benefits for founding members.
data . publications [] . benefits . founding []
string optional
data . publications [] . author object
The publication's main author.
data . publications [] . author . id
integer nullable
Numeric user id.
data . publications [] . author . name
string nullable
The name shown for the author.
data . publications [] . author . handle
string nullable
The author's handle.
data . publications [] . author . slug
string nullable
The author's profile slug.
data . publications [] . author . bio
string nullable
The author's short biography.
data . publications [] . author . photoUrl
string nullable
The author's profile photo URL.
data . publications [] . author . badge object nullable
The author's main badge, when there is one.
data . publications [] . author . badge . type
string nullable
The kind of badge, such as `bestseller`.
data . publications [] . author . badge . tier
integer nullable
The badge tier, when it has one.
data . publications [] . author . badge . handle
string nullable
The handle the badge belongs to.
data . publications [] . author . badge . service
string nullable
The service the badge comes from.
data . publications [] . author . badge . url
string nullable
A link for the badge, when it has one.
data . publications [] . author . badges
object nullable
The author's reader status fields, when available.
data . publications [] . author . bestsellerTier
integer nullable
The author's bestseller tier.
data . publications [] . author . primaryPublication object nullable
The author's primary publication, when there is one.
data . publications [] . author . primaryPublication . id
integer nullable
Numeric publication id.
data . publications [] . author . primaryPublication . name
string nullable
The publication's name.
data . publications [] . author . primaryPublication . subdomain
string nullable
The publication's Substack subdomain.
data . publications [] . author . primaryPublication . customDomain
string nullable
The publication's custom domain, when it has one.
data . publications [] . author . primaryPublication . logoUrl
string nullable
The publication's logo URL.
data . publications [] . audience object
Approximate audience figures the publication prints. These are bands, not counts.
data . publications [] . audience . paidLabel
string nullable
The band Substack displays for paid subscribers.
data . publications [] . audience . paidOrderOfMagnitude
integer nullable
The order of magnitude behind the paid band.
data . publications [] . audience . totalLabel
string nullable
The band Substack displays for all subscribers.
data . publications [] . audience . totalOrderOfMagnitude
integer nullable
The order of magnitude behind the total band.
data . publications [] . audience . freeLabel
string nullable
The band Substack displays for free subscribers.
data . publications [] . audience . freeShort
string nullable
The short free-subscriber band.
data . publications [] . audience . chatMembersLabel
string nullable
The band Substack displays for chat members.
data . publications [] . contributors array
People with a byline on the publication.
data . publications [] . contributors [] . id
integer nullable
Numeric user id.
data . publications [] . contributors [] . name
string nullable
The contributor's name.
data . publications [] . contributors [] . handle
string nullable
The contributor's handle.
data . publications [] . contributors [] . role
string nullable
The contributor's role on the publication.
data . publications [] . contributors [] . owner
boolean nullable
Whether the contributor owns the publication.
data . publications [] . contributors [] . photoUrl
string nullable
The contributor's photo URL.
data . publications [] . contributors [] . bio
string nullable
The contributor's short biography.
data . publications [] . contributors [] . badge object nullable
The contributor's badge.
data . publications [] . contributors [] . badge . type
string nullable
The kind of badge, such as `bestseller`.
data . publications [] . contributors [] . badge . tier
integer nullable
The badge tier, when it has one.
data . publications [] . contributors [] . badge . handle
string nullable
The handle the badge belongs to.
data . publications [] . contributors [] . badge . service
string nullable
The service the badge comes from.
data . publications [] . contributors [] . badge . url
string nullable
A link for the badge, when it has one.
data . publications [] . contributors [] . bestsellerTier
integer nullable
The contributor's bestseller tier.
data . publications [] . sections array
The publication's sections.
data . publications [] . sections [] . id
integer nullable
Numeric section id.
data . publications [] . sections [] . name
string nullable
The section's name.
data . publications [] . sections [] . description
string nullable
The section's description.
data . publications [] . sections [] . slug
string nullable
The section's URL slug.
data . publications [] . sections [] . isPodcast
boolean nullable
Whether the section is a podcast.
data . publications [] . sections [] . isLive
boolean nullable
Whether the section is a live stream.
data . publications [] . sections [] . isDefaultOn
boolean nullable
Whether the section is on by default.
data . publications [] . sections [] . logoUrl
string nullable
The section's logo URL.
data . publications [] . sections [] . coverImageUrl
string nullable
The section's cover image URL.
data . publications [] . sections [] . hideFromNavbar
boolean nullable
Whether the section is hidden from navigation.
data . publications [] . sections [] . hidePostsFromPubListings
boolean nullable
Whether the section's posts are hidden from publication lists.
data . publications [] . links array
Links the publication shows.
data . publications [] . links [] . id
integer nullable
Numeric link id.
data . publications [] . links [] . url
string
The link.
data . publications [] . links [] . platform
string nullable
`apple_podcasts`, `spotify`, `youtube` or another label Substack uses.
data . publications [] . links [] . sectionId
integer nullable
The section the link belongs to, when it has one.
data . publications [] . plans array
The subscription plans the publication offers.
data . publications [] . plans [] . id
string nullable
The plan's id.
data . publications [] . plans [] . nickname
string nullable
The plan's display name.
data . publications [] . plans [] . amount
integer nullable
Price in the currency's minor unit.
data . publications [] . plans [] . currency
string nullable
Currency code for the price.
data . publications [] . plans [] . interval
string nullable
`month`, `year` or Substack's own value.
data . publications [] . plans [] . intervalCount
integer nullable
How many intervals one charge covers.
data . publications [] . plans [] . active
boolean nullable
Whether the plan is on sale.
data . publications [] . plans [] . founding
boolean
Whether this is a founding-member plan.
data . publications [] . podcast object
The publication's podcast, when it has one.
data . publications [] . podcast . exists
boolean nullable
Whether the publication has a podcast.
data . publications [] . podcast . hasFreeEpisodes
boolean nullable
Whether free episodes are available.
data . publications [] . podcast . hasPaidEpisodes
boolean nullable
Whether paid episodes are available.
data . publications [] . podcast . artUrl
string nullable
The podcast artwork URL.
data . publications [] . podcast . byline
string nullable
The podcast byline.
data . publications [] . podcast . description
string nullable
The podcast description.
data . publications [] . podcast . feedUrl
string nullable
The podcast feed URL.
data . publications [] . podcast . title
string nullable
The podcast title.
data . publications [] . podcast . paidEpisodeArtUrl
string nullable
Artwork for paid episodes.
Page-number pagination state for the current page.
True when another page exists.
data . page . nextPage
integer nullable
The next page number; null on the last page.
data . emptyIsUnverified
boolean
True when the list is empty but it could not be confirmed that the query has no matches. Such a response is still charged, like any other `200` answer.
Metadata describing the request and billing outcome.
Unique request identifier for tracing this API call.
meta . creditsCharged
integer
Credits charged for this request.
Public API version that served the response.