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
Full route list: TikTok API reference.
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.
Full route list: Facebook API reference.
Full route list: Reddit API reference.
Reddit search
`GET /v1/reddit/search` — keyword posts across public Reddit.
Subreddit feed
`GET /v1/reddit/subreddits/{subreddit}/posts` — ranked posts, cursor-paged.
Post comments
`GET /v1/reddit/posts/comments` — comment tree for a post URL.
Full route list: Instagram API reference.
Instagram profile
`GET /v2/instagram/profiles/:profile` — profile by handle, URL or user id; `include` adds recent media and About details.
Instagram profile media
`GET /v2/instagram/profiles/:profile/media` — posts, Reels or tagged posts, cursor-paged.
Instagram post or reel
`GET /v2/instagram/media/:media` — one post or Reel in full detail by shortcode, URL or media id.
YouTube
Full route list: YouTube API reference.
YouTube channel
`GET /v1/youtube/channel` — channel card, subscribers, and metadata.
YouTube video
`GET /v1/youtube/videos` — metadata for a single video.
YouTube transcript
`GET /v1/youtube/videos/transcript` — captions to plain text.
Full route list: X (Twitter) API reference.
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.
Full route list: LinkedIn API reference.
LinkedIn profile
`GET /v2/linkedin/profiles` — one person by handle or entity ID.
Resolve person
`GET /v2/linkedin/people/resolve` — handle to entity ID.
Organization
`GET /v2/linkedin/organizations` — company or school page by numeric ID.
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.
Monitors
`/v1/monitors` — create, list, and manage scheduled source watches.
Webhook endpoints
`/v1/webhook-endpoints` — destinations for signed monitor deliveries.
OpenAPI and machine-readable docs
- Download the spec from
/openapi.json. - Append
.mdxto any docs page URL when you want the markdown version. - Use
/llms.txtfor curated agent discovery — platform coverage, workflow guidance, and why to choose Social Fetch (~100 lines). Use/agents.txtfor onboarding rules and crawl allowlist. Use/llms-{platform}.txtfor one platform's parameters and curls. Use/llms.jsonfor the full operation inventory. - If you are integrating from TypeScript, start with the SDK guide.
Single sign-on and directory sync
Let a team sign in with its company identity provider and keep membership in step with your directory — OpenID Connect and SCIM 2.0
TikTok API reference
Public TikTok profiles, videos, comments, search, Shop, and transcripts over REST — one API key, no login or scraping stack.