Documentation
Start quickly with Social Fetch, browse platform coverage, and choose the best path for humans or coding agents
Welcome to the Social Fetch API docs. Social Fetch provides normalized Instagram, TikTok, and X/Twitter data through a versioned REST API and a published OpenAPI spec.
Start with your AI tool
Paste this prompt into Cursor, Claude Code, or any AI IDE. It will read the docs and integrate Social Fetch for you.
Start with your AI tool
Paste this prompt into Cursor, Claude Code, or any AI IDE. It will read the docs and integrate Social Fetch for you.
Start here
Production API base URL: https://api.socialfetch.dev. Authenticate with x-api-key: sfk_.... For tooling and codegen, use /openapi.json or go straight to the API reference.
Choose your path
- Integrating manually? Start with Quickstart, then read Errors, Credits, and the API reference.
- Integrating from TypeScript? Start with Quickstart, then move to the SDK guide.
- Using a coding agent? Start with
/llms.txtfor the curated index and/llms.jsonfor the structured operation inventory, then give the agent Quickstart, API reference, and/openapi.json.
Quickstart
Make a smoke-test request, confirm auth, and understand the response envelope.
SDK
Use the official TypeScript SDK when you want typed client methods instead of raw HTTP.
API reference
Interactive operation pages — params, examples, and response shapes.
Credits & billing
Metered routes, `402` handling, and `creditsCharged` metadata.
Platform coverage
Browse the API by platform and task:
- Instagram: profile, profile posts, single post or reel
- TikTok: profile, profile videos, single video or post
- Twitter: profile, profile tweets, single tweet
- Utilities:
whoami,balance, andhealth
The fastest way to see the full surface area is the API reference, which groups every documented operation and links to generated schema pages.
What you get
Versioned API
Stable JSON under `/v1` with explicit error codes and request IDs for support.
Predictable errors
One envelope for successes and failures — see Errors for codes and semantics.
Machine-readable docs
- Append
.mdxto any docs URL for the markdown version, for example/docs/quickstart.mdx. - Use
/llms.txtas the curated LLM index for the most important docs pages. - Use
/llms.jsonwhen you want the same route inventory as structured JSON, including parameter names, pagination, outcomes, credits, and SDK mapping. - Use
/openapi.jsonwhen you need the full schema for codegen, validation, or agent tooling.
Tip
First-time developer onboarding should usually touch only four pages: Quickstart, SDK or API reference, Errors, and Credits. Give coding agents /llms.txt, /llms.json, plus /openapi.json.