Guides
Authentication
Create a customer API key on your account page. Use it for every platform at https://api.scrapeatlas.com.
Send the key in a header
Send x-api-key: sa_live_… or Authorization: Bearer sa_live_…. Keep keys private. The playground sends your key only to the configured API origin. Revocation takes effect within 60 seconds.
curl "https://api.scrapeatlas.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fexample" \
-H "x-api-key: YOUR_API_KEY"Private worker configuration
| Worker | Header | Configuration | Local origin |
|---|---|---|---|
| Amazon | x-api-key | AMAZON_API_KEY | http://localhost:3024 |
| Bluesky | x-api-key | BLUESKY_API_KEY | http://localhost:3013 |
| Couchsurfing | x-api-key | COUCHSURFING_API_KEY | http://localhost:3018 |
| Depop | x-api-key | DEPOP_API_KEY | http://localhost:3033 |
| Etsy | x-api-key | ETSY_API_KEY | http://localhost:3032 |
| Facebook Events | x-api-key | FACEBOOK_API_KEY | http://localhost:3039 |
| Facebook Marketplace | x-api-key | FACEBOOK_API_KEY | http://localhost:3039 |
x-api-key | FACEBOOK_API_KEY | http://localhost:3039 | |
| GitHub | x-api-key | GITHUB_API_KEY | http://localhost:3021 |
| Hacker News | x-api-key | HACKERNEWS_API_KEY | http://localhost:3015 |
x-api-key | INSTAGRAM_API_KEY | http://localhost:3037 | |
| Kick | x-api-key | KICK_API_KEY | http://localhost:3011 |
| Komi | x-api-key | KOMI_API_KEY | http://localhost:3008 |
| Kwai | x-api-key | KWAI_API_KEY | http://localhost:3017 |
| Lnk.Bio | x-api-key | LINKBIO_API_KEY | http://localhost:3030 |
| LinkedIn Ads Library | x-api-key | LINKEDIN_ADS_API_KEY | http://localhost:3029 |
x-api-key | LINKEDIN_API_KEY | http://localhost:3028 | |
| Linkme | x-api-key | LINKME_API_KEY | http://localhost:3009 |
| Linktree | x-api-key | LINKTREE_API_KEY | http://localhost:3007 |
| Meetup | x-api-key | MEETUP_API_KEY | http://localhost:3016 |
| Meta Ads Library | x-api-key | META_ADS_API_KEY | http://localhost:3023 |
| Pillar | x-api-key | PILLAR_API_KEY | http://localhost:3010 |
x-api-key | PINTEREST_API_KEY | http://localhost:3014 | |
| Quora | x-api-key | QUORA_API_KEY | http://localhost:3034 |
x-reddit-retrieval-secret | REDDIT_RETRIEVAL_SERVICE_SECRET | http://localhost:3006 | |
| Rumble | x-api-key | RUMBLE_API_KEY | http://localhost:3019 |
| Skool | x-api-key | SKOOL_API_KEY | http://localhost:3022 |
| Telegram | x-api-key | TELEGRAM_API_KEY | http://localhost:3020 |
| Threads | x-api-key | THREADS_API_KEY | http://localhost:3040 |
| TikTok Shop | x-api-key | TIKTOK_SHOP_API_KEY | http://localhost:3035 |
| TikTok | x-api-key | TIKTOK_API_KEY | http://localhost:3038 |
| Truth Social | x-api-key | TRUTHSOCIAL_API_KEY | http://localhost:3027 |
| Twitch | x-api-key | TWITCH_API_KEY | http://localhost:3012 |
| X (Twitter) | x-api-key | TWITTER_API_KEY | http://localhost:3036 |
| Account usage | x-api-key | CUSTOMER_API_KEY | http://localhost:3100 |
| Vinted | x-api-key | VINTED_API_KEY | http://localhost:3031 |
| Whatnot | x-api-key | WHATNOT_API_KEY | http://localhost:3025 |
| YouTube | x-api-key | YOUTUBE_API_KEY | http://localhost:3026 |
These headers and origins are for operators running workers directly. The public gateway always accepts a customer key in x-api-key, including Reddit’s unchanged legacy paths.
Failures
Missing, invalid, revoked or expired customer key. The gateway returns failure.code = unauthorized.
No available account credits. Each successful retrieval request costs one credit, including partial results. Failed requests, authentication checks and preflights cost zero. Read x-credits-charged and x-credits-remaining response headers. Top-ups are managed by the account operator until checkout is available.
An account exceeds 60 requests per minute or four concurrent requests, or a source rate-limits retrieval. Respect retry-after. Global capacity or unavailable platforms return 503 busy.