SocialCrawl API Documentation
One API key and one response schema for social, commerce, and research data across every platform SocialCrawl covers
SocialCrawl returns social, commerce, and research data from 55 platforms through 449 endpoints, behind one API key and one response envelope. You write one parser and query every platform with it.
Quickstart
Make your first call in under a minute. 100 welcome credits, no card required.
Authentication
Create keys, cap their spend, rotate them, and keep them off the client.
API Reference
Every endpoint with an interactive playground and full response schemas.
Recipes
Ten runnable TypeScript builds, each with its credit cost attached.
What you get
| Capability | What it means |
|---|---|
| Unified schema | Every platform returns the same envelope, so one parser covers all of them. See Response schema. |
| One credential | A single x-api-key header. No OAuth flow, no per-platform tokens. See Authentication. |
| Computed fields | When an endpoint supports a computed field and the required source inputs are present, engagement_rate, language, content_category, and estimated_reach arrive pre-calculated, and null when they cannot be derived. See Computed fields. |
| Credit billing | You pay per successful call. Cached and failed responses are not charged. See Credits. |
| Safe retries | Send an Idempotency-Key header and a replay returns the original response for 24 hours, deducting 0 new credits. See Idempotency. |
| Live balance | GET /v1/credits/balance returns your remaining credits and costs 0. See Credits. |
| One paging rule | Send next_cursor back as cursor, stop when has_more is false. Same on every list endpoint. See Pagination. |
Why use a unified API?
Building against 55 platforms directly means 55 authentication models, 55 rate-limit regimes, 55 response formats, and 55 error vocabularies to keep working. SocialCrawl collapses that into one interface: the same envelope on every success, the same error codes on every failure, and a doc_url on each error that points at the page explaining it.
Per-key rate and concurrency limits are documented in Rate limits, and the endpoint pairs developers most often confuse are laid out side by side, with prices, in Which endpoint should I use?.
Which platforms does SocialCrawl support?
Frequently asked questions
How do I authenticate with the SocialCrawl API?
Pass your API key in the x-api-key header on every request. Sign up at socialcrawl.dev, open Dashboard → API Keys, and create a key. There is no OAuth flow, token exchange, or session to manage.
Which platforms does the SocialCrawl API support?
SocialCrawl covers 55 platforms through 449 endpoints (including TikTok, Instagram, YouTube, Facebook, Twitter/X, LinkedIn, Reddit, Threads, Pinterest, and Twitch) plus research sources like GitHub, Hacker News, Tavily, and Perplexity.
What does the SocialCrawl response envelope look like?
Every response (success or error) uses the same JSON envelope: success, platform, endpoint, data, credits_used, credits_remaining, request_id, and cached. List responses return data as { items, next_cursor }, and computed fields like engagement_rate arrive pre-calculated on every author and post.
How do I use SocialCrawl with Claude, Cursor, or other MCP clients?
Install the MCP server with npx -y socialcrawl-mcp. In Claude Code, run: claude mcp add --scope user socialcrawl -- npx -y socialcrawl-mcp. In Claude Desktop, Cursor, VS Code, or Windsurf, add socialcrawl-mcp to your mcpServers config with your SOCIALCRAWL_API_KEY.
How many free credits do I get when I sign up?
Every new account receives 100 welcome credits automatically on signup. Standard endpoints cost 1 credit per request, so that is up to 100 free requests to evaluate the API, and cache hits cost 0 credits.
