Quickstart

Make your first SocialCrawl API request in under a minute. New accounts get 100 welcome credits — enough to try every standard endpoint without adding a payment method.

1. Get Your API Key

Sign up at socialcrawl.dev and create a key in Dashboard → API Keys. Keys have the format sc_ + 32 random bytes (46 characters total) and are shown in full exactly once on creation — copy it somewhere safe.

2. Make a Request

curl "https://socialcrawl.dev/v1/tiktok/profile?handle=charlidamelio" \
  -H "x-api-key: YOUR_API_KEY"

3. Read the Response

Every response follows the same envelope format:

{
  "success": true,
  "platform": "tiktok",
  "endpoint": "/v1/tiktok/profile",
  "data": {
    "author": {
      "username": "charlidamelio",
      "followers": 155000000,
      "following": 1200,
      "likes_count": 11200000000
    },
    "computed": {
      "engagement_rate": 0.082,
      "language": "en",
      "content_category": "entertainment",
      "estimated_reach": 12710000
    }
  },
  "credits_used": 1,
  "credits_remaining": 99,
  "request_id": "req-abc123",
  "cached": false
}

Responses also include useful headers: X-Request-Id, X-Credits-Used, X-Credits-Remaining, and X-Cache (HIT when served from cache — cache hits cost 0 credits).

4. Retry Safely (Optional)

Add an Idempotency-Key header to make any request safe to retry. Replays return the original response and deduct 0 new credits.

curl "https://socialcrawl.dev/v1/tiktok/profile?handle=charlidamelio" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

What should I build next?

• Authentication — manage keys, rotate them, protect them
• Response Schema — the unified envelope, headers, and _warnings
• Credits — tiers, refunds, free cache hits, balance endpoint
• Error Handling — every error code and when to retry
• API Reference — try any of the 108 endpoints live

Building an AI agent? See AI Agent Integration and Skills & MCP.