API reference

Browse Social Fetch endpoints by platform and task, with direct links to generated schema pages and the raw OpenAPI spec

These pages are generated from the same public OpenAPI spec the API serves. Parameters, status codes, schemas, and examples stay aligned with production.

Best way to navigate

Start from the platform or task you care about, then drill into the generated operation page for exact schemas and examples. If you are using a coding agent, the markdown version of this page lives at /docs/api.mdx.

TikTok

TikTok profile

`GET /v1/tiktok/profiles/:handle` — normalized public profile + metrics.

TikTok profile videos

`GET /v1/tiktok/profiles/:handle/videos` — paginated videos for a profile.

TikTok video or post

`GET /v1/tiktok/videos/...` — normalized metadata for a single TikTok video.

Facebook

Facebook profile

`GET /v1/facebook/profiles` — normalized public profile or page lookup by URL.

Instagram

Instagram profile

`GET /v1/instagram/profiles/:handle` — profile, metrics, recent posts, related accounts.

Instagram profile posts

`GET /v1/instagram/profiles/:handle/posts` — paginated posts for a profile.

Instagram post or reel

`GET /v1/instagram/posts/...` — metadata for a single post or reel.

Twitter

Twitter profile

`GET /v1/twitter/profiles/:handle` — normalized public profile and metrics.

Twitter profile tweets

`GET /v1/twitter/profiles/:handle/tweets` — paginated tweets for a profile.

Twitter tweet

`GET /v1/twitter/tweets/...` — normalized metadata for a single tweet.

Utilities

Whoami

`GET /v1/whoami` — validate keys; no credits charged.

Balance

`GET /v1/balance` — current credit balance; no credits charged.

Health check

`GET /health` — liveness probe, no authentication.

OpenAPI and machine-readable docs

Download the spec from /openapi.json.
Append .mdx to any docs page URL when you want the markdown version.
Use /llms.txt for curated agent discovery — platform coverage, workflow guidance, and why to choose Social Fetch (~100 lines). Use /agents.txt for onboarding rules and crawl allowlist. Use /llms-{platform}.txt for one platform's parameters and curls. Use /llms.json for the full operation inventory.
If you are integrating from TypeScript, start with the SDK guide.