> **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):** - **Markdown (.mdx) URL:** ## 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:** ## 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`). --- # Search Substack profiles (https://www.socialfetch.dev/docs/api/v1/substack/search/profiles/get) ## Summary Search Substack profiles by text. **Tags:** `Substack` ## HTTP - **Method:** GET - **Path:** `/v1/substack/search/profiles` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.substack.searchProfiles({ query: "climate" })` - **Accepted identifiers:** `query` (query) - **Pagination:** page via `page`, next page: `data.page.nextPage`, has more: `data.page.hasMore` - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## 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 ### `query` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 200 - **Description:** Text to search profiles for. ### `page` (query) - **Required:** no - **Constraints:** type `integer`; default: `0`; minimum: 0; maximum: 100000; nullable - **Description:** Page number, 0 to 100,000; twenty profiles a page. Only pages 0 to 3 have results, so a page past 3 returns an empty list with `hasMore: false`. ## Responses (status codes) - **200**: Substack profile search. - **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 profile search. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the search ran. - **query** (required) — type `string`. The query that was searched. - **profiles** (required) — type `array`. Matching profiles. Their `subscriptions` array is empty here; use `profile.subscriptions.list` for the paged list. - _items:_ - **id** (required) — type `integer`. Numeric user id. - **name** (required) — type `string`; nullable. The reader's display name. - **handle** (required) — type `string`; nullable. The reader's handle. - **slug** (required) — type `string`; nullable. The reader's profile slug. - **bio** (required) — type `string`; nullable. The reader's short biography. - **photoUrl** (required) — type `string`; nullable. The reader's profile photo URL. - **createdAt** (required) — type `string`; nullable. ISO 8601 timestamp, or null when Substack does not publish one. - **isDisabled** (required) — type `boolean`; nullable. Whether the profile is disabled. - **followerCount** (required) — type `integer`; nullable. The number of followers. - **subscriberCount** (required) — type `integer`; nullable. The numeric count. - **subscriberCountLabel** (required) — type `string`; nullable. The label Substack displays. - **roughFreeSubscribers** (required) — type `string`; nullable. The free-subscriber band Substack displays. - **roughFreeSubscribersInt** (required) — type `integer`; nullable. The numeric value behind the free band. - **roughSubscribers** (required) — type `string`; nullable. The subscriber band Substack displays. - **roughSubscribersInt** (required) — type `integer`; nullable. The numeric value behind the subscriber band. - **badges** (required) — type `object`; nullable. The reader's status fields, when available. - **bestsellerTier** (required) — type `integer`; nullable. The reader's bestseller tier. - **leaderboard** (required) — type `object`; nullable. The reader's leaderboard position. - **links** (required) — type `array`. Links the reader shows. - _items:_ - **publicationUrl** (required) — type `string`; nullable. The reader's publication URL. - **hasNotes** (required) — type `boolean`; nullable. Whether the reader has Notes. - **hasGuestPost** (required) — type `boolean`; nullable. Whether the reader has a guest post. - **hasLikes** (required) — type `boolean`; nullable. Whether the reader has likes. - **hasPosts** (required) — type `boolean`; nullable. Whether the reader has posts. - **recommendationCount** (required) — type `integer`; nullable. The number of recommendations. - **primaryPublication** (required) — type `object`; nullable. The reader's primary publication. - **publications** (required) — type `array`. Publications the reader writes for. - _items:_ - **subscriptions** (required) — type `array`. Publications the reader shows publicly. - _items:_ - **subscriptionCount** (required) — type `integer`; nullable. The number of public subscriptions. - **subscriptionsTruncated** (required) — type `boolean`; nullable. True when Substack cut the subscription list. - **page** (required) — type `object`. Page-number pagination state for the current page. - **page** (required) — type `integer`; minimum: 0. Current page (0-based). - **hasMore** (required) — type `boolean`. True when another page exists. - **nextPage** (required) — type `integer`; minimum: 0; nullable. The next page number; null on the last page. - **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", "query": "李", "profiles": [ { "id": 523207455, "name": "李豪", "handle": "lee23hao", "slug": "674e8c6a", "bio": "我是李豪，你好", "photoUrl": "https://substack-post-media.s3.amazonaws.com/public/images/1619fa45-e09c-4d7f-b382-00d1d8db0bf6_1149x1149.jpeg", "createdAt": "2026-06-25T16:32:05.105Z", "isDisabled": false, "followerCount": 2, "subscriberCount": 0, "subscriberCountLabel": "See subscribers", "roughFreeSubscribers": null, "roughFreeSubscribersInt": null, "roughSubscribers": null, "roughSubscribersInt": null, "badges": null, "bestsellerTier": null, "leaderboard": null, "links": [ { "id": 5862420, "value": "@lee23hao", "url": "https://instagram.com/lee23hao", "type": "instagram", "label": "Instagram" } ], "publicationUrl": null, "hasNotes": true, "hasGuestPost": false, "hasLikes": false, "hasPosts": true, "recommendationCount": 0, "primaryPublication": { "id": 9692439, "name": "李豪", "subdomain": "lee23hao", "customDomain": null, "apexDomain": null, "url": "https://lee23hao.substack.com", "host": "lee23hao.substack.com", "description": null, "language": null, "kind": null, "createdAt": null, "firstPostAt": null, "hasPosts": null, "isExplicit": false, "isInviteOnly": null, "isFlagged": null, "noIndex": null, "isOnSubstack": null, "commentsEnabled": null, "notesEnabled": null, "defaultCommentSort": null, "annualDisabled": null, "monthlyDisabled": null, "paymentsState": "disabled", "freeTrialEnabled": null, "pausedUntil": null, "emailBannerUrl": null, "copyright": null, "logoUrl": null, "wideLogoUrl": null, "coverImageUrl": null, "foundingPlanName": null, "hasRecommendations": null, "benefits": { "free": [], "paid": [], "founding": [] }, "author": { "id": 523207455, "name": null, "handle": null, "slug": null, "bio": null, "photoUrl": null, "badge": null, "badges": null, "bestsellerTier": null, "primaryPublication": null }, "audience": { "paidLabel": null, "paidOrderOfMagnitude": null, "totalLabel": null, "totalOrderOfMagnitude": null, "freeLabel": null, "freeShort": null, "chatMembersLabel": null }, "contributors": [], "sections": [], "links": [], "plans": [], "podcast": { "exists": null, "hasFreeEpisodes": null, "hasPaidEpisodes": null, "artUrl": null, "byline": null, "description": null, "feedUrl": null, "title": null, "paidEpisodeArtUrl": null } }, "publications": [ { "role": "admin", "public": true, "isPrimary": true, "publication": { "id": 9692439, "name": "李豪", "subdomain": "lee23hao", "customDomain": null, "apexDomain": null, "url": "https://lee23hao.substack.com", "host": "lee23hao.substack.com", "description": "我是李豪，你好", "language": null, "kind": null, "createdAt": "2026-06-25T16:32:17.825Z", "firstPostAt": null, "hasPosts": null, "isExplicit": false, "isInviteOnly": false, "isFlagged": null, "noIndex": null, "isOnSubstack": null, "commentsEnabled": true, "notesEnabled": null, "defaultCommentSort": null, "annualDisabled": null, "monthlyDisabled": null, "paymentsState": "disabled", "freeTrialEnabled": null, "pausedUntil": null, "emailBannerUrl": null, "copyright": "李豪", "logoUrl": "https://substack-post-media.s3.amazonaws.com/public/images/1619fa45-e09c-4d7f-b382-00d1d8db0bf6_1149x1149.jpeg", "wideLogoUrl": "https://substack-post-media.s3.amazonaws.com/public/images/1d75e34a-71a2-45a8-88f6-b4fadf6ecc5a_851x315.jpeg", "coverImageUrl": null, "foundingPlanName": null, "hasRecommendations": null, "benefits": { "free": [], "paid": [], "founding": [] }, "author": { "id": 523207455, "name": null, "handle": null, "slug": null, "bio": null, "photoUrl": null, "badge": null, "badges": null, "bestsellerTier": null, "primaryPublication": null }, "audience": { "paidLabel": null, "paidOrderOfMagnitude": null, "totalLabel": null, "totalOrderOfMagnitude": null, "freeLabel": null, "freeShort": null, "chatMembersLabel": null }, "contributors": [], "sections": [], "links": [], "plans": [], "podcast": { "exists": null, "hasFreeEpisodes": null, "hasPaidEpisodes": null, "artUrl": null, "byline": null, "description": null, "feedUrl": null, "title": null, "paidEpisodeArtUrl": null } } } ], "subscriptions": [], "subscriptionCount": 0, "subscriptionsTruncated": false } ], "page": { "page": 0, "hasMore": true, "nextPage": 1 } }, "meta": { "requestId": "req_215a61e2-6a32-463d-922b-450509bcf595", "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.searchProfiles({ query: "climate", }); 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/search/profiles?query=climate", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v1/substack/search/profiles?query=climate" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v1/substack/search/profiles?query=climate", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```