> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration.

## This page

- **On-site (HTML):** <https://www.socialfetch.dev/docs/api/v1/substack/publications/publication/get>
- **Markdown (.mdx) URL:** <https://www.socialfetch.dev/docs/api/v1/substack/publications/publication/get.mdx>

## API base URL and authentication

- **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev`
- **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route).
- **OpenAPI JSON:** <https://www.socialfetch.dev/openapi.json>

## Recommended docs entrypoints (this site)

- [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown).
- [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope.
- [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`.
- [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages.
- [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
- [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
- [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install.
- [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 910 endpoint tools, plus docs_search/docs_read for implementation help.
- [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples.
- [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
- [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog.
- [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI).
- [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
- [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
- [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
- [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages.
- [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance.
- [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs.
- Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract.

## Markdown docs convention

- Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`).
- Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`).
- Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`).

---
# Get Substack publication (https://www.socialfetch.dev/docs/api/v1/substack/publications/publication/get)

## Summary

Get Substack publication metadata, plans, audience bands and sections.

**Tags:** `Substack`

## HTTP

- **Method:** GET
- **Path:** `/v1/substack/publications/{publication}`
- **Base URL:** `https://api.socialfetch.dev`

## Capability summary

- **SDK mapping:** `client.substack.getPublication({ publication: "astralcodexten" })`
- **Accepted identifiers:** `publication` (path)
- **Pagination:** none
- **Business outcome field:** `data.lookupStatus` with values `found`, `not_found`, `restricted`

## Credits

- **Base:** 1 credit per successful lookup.
- **Maximum on success (200):** 1 credit.
- **Failed requests (`lookup_failed`, `503`):** not charged.
- **Authoritative field:** `meta.creditsCharged`.

## Authentication

- **`x-api-key`**: API key (`sfk_...`)

## Parameters

### `publication` (path)

- **Required:** yes
- **Constraints:** type `string`; minLength: 1; maxLength: 400
- **Description:** A publication: its numeric id (`89120`), its Substack subdomain (`astralcodexten`), its host (`www.astralcodexten.com`) or its URL. A numeric id is refused with a 400 on the routes that need a subdomain, host or URL.

## Responses (status codes)

- **200**: Substack publication.
- **400**: Invalid request
- **401**: Missing or invalid API key
- **402**: Insufficient credits
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed.
- **503**: Service temporarily unavailable; safe to retry with backoff.

## Response body (200)

Substack publication.

### Field outline

- **data** (required) — type `object`. Endpoint-specific response payload.
  - **lookupStatus** (required) — type `string`; enum: found, not_found, restricted. Whether the publication was found.
  - **restrictedReason** (required) — type `string`; enum: invite_only, flagged, paid, null; nullable. Why the publication is restricted, when it is.
  - **publication** (required) — type `object`; nullable. The publication when `lookupStatus` is `found`; otherwise null.
    - **id** (required) — type `integer`. Numeric publication id.
    - **name** (required) — type `string`; nullable. The publication's name.
    - **subdomain** (required) — type `string`; nullable. The publication's Substack subdomain.
    - **customDomain** (required) — type `string`; nullable. The publication's custom domain, when it has one.
    - **apexDomain** (required) — type `string`; nullable. The publication's apex domain, when it has one.
    - **url** (required) — type `string`; nullable. The publication's canonical base URL.
    - **host** (required) — type `string`; nullable. The host its pages are served from.
    - **description** (required) — type `string`; nullable. The publication's description.
    - **language** (required) — type `string`; nullable. The publication's language code.
    - **kind** (required) — type `string`; nullable. `newsletter`, `podcast` or Substack's own type.
    - **createdAt** (required) — type `string`; nullable. ISO 8601 timestamp, or null when Substack does not publish one.
    - **firstPostAt** (required) — type `string`; nullable. ISO 8601 timestamp, or null when Substack does not publish one.
    - **hasPosts** (required) — type `boolean`; nullable. Whether the publication has posts.
    - **isExplicit** (required) — type `boolean`; nullable. Whether the publication is marked explicit.
    - **isInviteOnly** (required) — type `boolean`; nullable. Whether the publication is invite-only.
    - **isFlagged** (required) — type `boolean`; nullable. Whether the publication is flagged.
    - **noIndex** (required) — type `boolean`; nullable. Whether search engines are asked not to index it.
    - **isOnSubstack** (required) — type `boolean`; nullable. Whether the publication is hosted by Substack.
    - **commentsEnabled** (required) — type `boolean`; nullable. Whether comments are enabled.
    - **notesEnabled** (required) — type `boolean`; nullable. Whether Notes are enabled.
    - **defaultCommentSort** (required) — type `string`; nullable. The default comment order.
    - **annualDisabled** (required) — type `boolean`; nullable. Whether annual plans are disabled.
    - **monthlyDisabled** (required) — type `boolean`; nullable. Whether monthly plans are disabled.
    - **paymentsState** (required) — type `string`; nullable. The publication's payments state.
    - **freeTrialEnabled** (required) — type `boolean`; nullable. Whether a free trial is offered.
    - **pausedUntil** (required) — type `string`; nullable. ISO 8601 timestamp, or null when Substack does not publish one.
    - **emailBannerUrl** (required) — type `string`; nullable. The email banner image URL.
    - **copyright** (required) — type `string`; nullable. The copyright line the publication prints.
    - **logoUrl** (required) — type `string`; nullable. The publication's logo URL.
    - **wideLogoUrl** (required) — type `string`; nullable. The publication's wide logo URL.
    - **coverImageUrl** (required) — type `string`; nullable. The publication's cover image URL.
    - **foundingPlanName** (required) — type `string`; nullable. The name of the founding-member plan.
    - **hasRecommendations** (required) — type `boolean`; nullable. Whether the publication recommends others.
    - **benefits** (required) — type `object`. The benefit lists for each subscription tier.
      - **free** (required) — type `array`. Benefits for free subscribers.
        - _items:_
          - type `string`
      - **paid** (required) — type `array`. Benefits for paid subscribers.
        - _items:_
          - type `string`
      - **founding** (required) — type `array`. Benefits for founding members.
        - _items:_
          - type `string`
    - **author** (required) — type `object`. The publication's main author.
      - **id** (required) — type `integer`; nullable. Numeric user id.
      - **name** (required) — type `string`; nullable. The name shown for the author.
      - **handle** (required) — type `string`; nullable. The author's handle.
      - **slug** (required) — type `string`; nullable. The author's profile slug.
      - **bio** (required) — type `string`; nullable. The author's short biography.
      - **photoUrl** (required) — type `string`; nullable. The author's profile photo URL.
      - **badge** (required) — type `object`; nullable. The author's main badge, when there is one.
      - **badges** (required) — type `object`; nullable. The author's reader status fields, when available.
      - **bestsellerTier** (required) — type `integer`; nullable. The author's bestseller tier.
      - **primaryPublication** (required) — type `object`; nullable. The author's primary publication, when there is one.
    - **audience** (required) — type `object`. Approximate audience figures the publication prints. These are bands, not counts.
      - **paidLabel** (required) — type `string`; nullable. The band Substack displays for paid subscribers.
      - **paidOrderOfMagnitude** (required) — type `integer`; nullable. The order of magnitude behind the paid band.
      - **totalLabel** (required) — type `string`; nullable. The band Substack displays for all subscribers.
      - **totalOrderOfMagnitude** (required) — type `integer`; nullable. The order of magnitude behind the total band.
      - **freeLabel** (required) — type `string`; nullable. The band Substack displays for free subscribers.
      - **freeShort** (required) — type `string`; nullable. The short free-subscriber band.
      - **chatMembersLabel** (required) — type `string`; nullable. The band Substack displays for chat members.
    - **contributors** (required) — type `array`. People with a byline on the publication.
      - _items:_
    - **sections** (required) — type `array`. The publication's sections.
      - _items:_
    - **links** (required) — type `array`. Links the publication shows.
      - _items:_
    - **plans** (required) — type `array`. The subscription plans the publication offers.
      - _items:_
    - **podcast** (required) — type `object`. The publication's podcast, when it has one.
      - **exists** (required) — type `boolean`; nullable. Whether the publication has a podcast.
      - **hasFreeEpisodes** (required) — type `boolean`; nullable. Whether free episodes are available.
      - **hasPaidEpisodes** (required) — type `boolean`; nullable. Whether paid episodes are available.
      - **artUrl** (required) — type `string`; nullable. The podcast artwork URL.
      - **byline** (required) — type `string`; nullable. The podcast byline.
      - **description** (required) — type `string`; nullable. The podcast description.
      - **feedUrl** (required) — type `string`; nullable. The podcast feed URL.
      - **title** (required) — type `string`; nullable. The podcast title.
      - **paidEpisodeArtUrl** (required) — type `string`; nullable. Artwork for paid episodes.
- **meta** (required) — type `object`. Metadata describing the request and billing outcome.
  - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call.
  - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request.
  - **version** (required) — type `string`; enum: v1. Public API version that served the response.

### Example JSON (found)

```json
{
  "data": {
    "lookupStatus": "found",
    "restrictedReason": null,
    "publication": {
      "id": 89120,
      "name": "Astral Codex Ten",
      "subdomain": "astralcodexten",
      "customDomain": "www.astralcodexten.com",
      "apexDomain": null,
      "url": "https://www.astralcodexten.com",
      "host": "www.astralcodexten.com",
      "description": "P(A|B) = [P(A)*P(B|A)]/P(B), all the rest is commentary.",
      "language": "en",
      "kind": "newsletter",
      "createdAt": "2020-08-30T04:18:18.308Z",
      "firstPostAt": "2020-08-30T21:01:57.050Z",
      "hasPosts": true,
      "isExplicit": false,
      "isInviteOnly": false,
      "isFlagged": false,
      "noIndex": false,
      "isOnSubstack": false,
      "commentsEnabled": true,
      "notesEnabled": false,
      "defaultCommentSort": "oldest_first",
      "annualDisabled": false,
      "monthlyDisabled": false,
      "paymentsState": "enabled",
      "freeTrialEnabled": false,
      "pausedUntil": null,
      "emailBannerUrl": null,
      "copyright": "Scott Alexander",
      "logoUrl": "https://substackcdn.com/image/fetch/$s_!bGN2!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fbucketeer-e05bbc84-baa3-437e-9518-adb32be77984.s3.amazonaws.com%2Fpublic%2Fimages%2F430241cb-ade5-4316-b1c9-6e3fe6e63e5e_256x256.png",
      "wideLogoUrl": null,
      "coverImageUrl": null,
      "foundingPlanName": "Founding Member",
      "hasRecommendations": true,
      "benefits": {
        "free": [
          "Public posts"
        ],
        "paid": [
          "Support me being able to blog more."
        ],
        "founding": []
      },
      "author": {
        "id": 12009663,
        "name": "Scott Alexander",
        "handle": "astralcodexten",
        "slug": "astralcodexten",
        "bio": null,
        "photoUrl": "https://substackcdn.com/image/fetch/$s_!HTBd!,f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fbucketeer-e05bbc84-baa3-437e-9518-adb32be77984.s3.amazonaws.com%2Fpublic%2Fimages%2F7b500d22-1176-42ad-afaa-5d72bc36a809_44x44.png",
        "badge": {
          "type": "bestseller",
          "tier": 1000,
          "handle": null,
          "service": null,
          "url": null
        },
        "badges": null,
        "bestsellerTier": 1000,
        "primaryPublication": null
      },
      "audience": {
        "paidLabel": null,
        "paidOrderOfMagnitude": null,
        "totalLabel": null,
        "totalOrderOfMagnitude": null,
        "freeLabel": null,
        "freeShort": null,
        "chatMembersLabel": "174K Members"
      },
      "contributors": [
        {
          "id": 12009663,
          "name": "Scott Alexander",
          "handle": "astralcodexten",
          "role": "admin",
          "owner": true,
          "photoUrl": "https://substackcdn.com/image/fetch/f_auto,q_auto:good,fl_progressive:steep/https%3A%2F%2Fbucketeer-e05bbc84-baa3-437e-9518-adb32be77984.s3.amazonaws.com%2Fpublic%2Fimages%2F7b500d22-1176-42ad-afaa-5d72bc36a809_44x44.png",
          "bio": null,
          "badge": {
            "type": "bestseller",
            "tier": 1000,
            "handle": null,
            "service": null,
            "url": null
          },
          "bestsellerTier": 1000
        }
      ],
      "sections": [],
      "links": [],
      "plans": [
        {
          "id": "monthly10usd",
          "nickname": "$10 a month",
          "amount": 1000,
          "currency": "usd",
          "interval": "month",
          "intervalCount": 1,
          "active": true,
          "founding": false
        }
      ],
      "podcast": {
        "exists": false,
        "hasFreeEpisodes": false,
        "hasPaidEpisodes": false,
        "artUrl": null,
        "byline": null,
        "description": null,
        "feedUrl": null,
        "title": null,
        "paidEpisodeArtUrl": null
      }
    }
  },
  "meta": {
    "requestId": "req_698ea3da-d807-4ae0-b694-5a655f6cb338",
    "creditsCharged": 1,
    "version": "v1"
  }
}
```

### Machine-readable error codes

When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime):

- `bad_request`

## Error handling & retries

Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status.

- **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help.
- **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help.
- **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help).
- **500**: Unexpected or billing error
- **502**: Lookup could not be completed. **Retry:** May be transient; a few retries with backoff are reasonable.
- **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter.

### Suggested client defaults

- Send the API key using the `x-api-key` header on every request.
- On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user.
- On `402`, surface an actionable billing message rather than blind retries.

## Examples

### TypeScript SDK

```typescript
import { SocialFetchClient } from "@socialfetch/sdk";

const client = new SocialFetchClient({
  apiKey: process.env.SOCIALFETCH_API_KEY!,
});

const result = await client.substack.getPublication({
  publication: "astralcodexten",
});

if (!result.ok) {
  console.error(result.error);
} else {
  console.log(result.value.data);
}
```

### Node.js

```javascript
const response = await fetch(
  "https://api.socialfetch.dev/v1/substack/publications/astralcodexten",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data);
```

### cURL

```bash
curl "https://api.socialfetch.dev/v1/substack/publications/astralcodexten" \
  -H "x-api-key: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.get(
    "https://api.socialfetch.dev/v1/substack/publications/astralcodexten",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()
print(data)
```