Social Fetch

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; for agent onboarding and crawl rules, use /agents.txt; for the full endpoint list with links to pages like this one, use /llms-endpoints.txt; for one platform's parameters and curls, use /llms-{platform}.txt; use /llms.json when you need structured JSON for tool registration.

This page

• On-site (HTML): https://www.socialfetch.dev/docs
• Markdown (.mdx) URL: https://www.socialfetch.dev/docs.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, /llms.txt, or /llms.json for each route).
• OpenAPI JSON: https://www.socialfetch.dev/openapi.json

Recommended docs entrypoints (this site)

• Documentation overview — top-level orientation (markdown).
• Quickstart — authenticate with x-api-key, validate auth with whoami, and understand the JSON envelope.
• SDK — official TypeScript SDK guide, including SocialFetchClient, Result, and unwrap().
• Capability matrix — 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 — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples.
• Integrations — MCP for AI clients, n8n verified node, Apify Store Actors, Make custom app, SDK, and REST API connection paths.
• MCP product page — hosted MCP overview, OAuth, Skills install.
• MCP integration — hosted /mcp server, OAuth, Cursor/VS Code/Claude install snippets, 240 endpoint tools, plus docs_search/docs_read for implementation help.
• n8n integration — install n8n-nodes-socialfetch, credentials, and workflow examples.
• Apify integration — Store Actors under @social-fetch, PPE billing, dataset export, and quick start.
• Make integration — custom app modules for Make scenarios, API key credentials, and module catalog.
• /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 — per-platform endpoint files generated from OpenAPI (parameters, credits, curls).
• /agents.txt — agent crawl/onboarding file with capabilities, auth rules, and allowlist.
• /llms.json — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping.
• API reference hub — human-friendly index of operations with links into generated pages.
• Errors — shared error envelope and HTTP status guidance.
• Credits — metering, 402, and planning batch jobs.
• Outcome semantics such as found, not_found, and private are documented in Errors 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).

---

Documentation (https://www.socialfetch.dev/docs)

Social Fetch is a REST API for normalized social media data. Look up profiles, posts, and engagement metrics across Instagram, TikTok, X/Twitter, YouTube, and more — one JSON shape, one API key.

Base URL https://api.socialfetch.dev · authenticate with the x-api-key: sfk_... header · grab the spec from /openapi.json. New here? Start with the Quickstart.

Pick your path

• Quickstart — Make your first authenticated request and learn the response envelope in a few minutes.

• Recipes — Copyable workflows — brand monitoring, transcripts, ads, creator scoring, Reddit research.

• TypeScript SDK — Typed client methods and Result-based error handling instead of raw HTTP.

• API reference — Every operation, with parameters, examples, and response schemas.

• Credits & billing — Which routes cost credits, how to read creditsCharged, and what 402 means.

• Integrations — SDK, MCP, n8n, Apify, x402 — connect Social Fetch to your stack.

Not sure where to begin? Match your setup:

• Calling the API directly — Quickstart → Errors → Credits → API reference.
• Building in TypeScript — Quickstart → SDK guide.
• Handing this to a coding agent — connect MCP, or point it at /llms.txt, /agents.txt, /llms.json, and /openapi.json.

Platform coverage

Every platform returns the same { data, meta } envelope.

• Instagram — profiles, posts, reels, highlights, search
• TikTok — profiles, videos, products, user search
• X/Twitter — profiles, tweets, communities, search
• YouTube — channels, videos, transcripts, playlists, search
• Yelp — paginated business reviews returned directly by the API (source availability varies by review category)
• Facebook, Reddit, LinkedIn, Pinterest, Threads, Bluesky, Twitch, GitHub, Rumble, Spotify, Apple Music, SoundCloud, Snapchat, Telegram, Linktree, Hacker News, Truth Social, Google, Amazon — profiles, posts, and platform-specific lookups
• Web — fetch any page as Markdown or HTML, or ask a question about it
• Monitors & webhooks — schedule recurring checks and receive signed deliveries
• Utilities — whoami, balance, and health

See the API reference for every operation and its schema.

Docs for machines

Building with a coding agent or generating client code:

• Append .mdx to any docs URL for the raw Markdown, e.g. /docs/quickstart.mdx.
• /llms.txt — curated discovery index: coverage, why to use it, workflow-oriented doc links (~100 lines).
• /agents.txt — agent onboarding, auth/pagination rules, and crawl allowlist.
• /llms-endpoints.txt — every operation with a link to that route's markdown page.
• /llms-{platform}.txt — per-platform files with parameters, credits, and example curls (from OpenAPI).
• /llms.json — structured route inventory with parameters, pagination, outcomes, credits, and SDK mappings.
• /openapi.json — full schema for codegen, validation, and tooling.
• Capability matrix — every operation in one generated table: identifiers, pagination, outcomes, credits, and SDK method. Prefer /llms.json for agents.