Authentication
How requests are authenticated, and how keys are issued today.
Every request needs a key in the X-API-Key header:
curl 'https://api.fluxcrawl.dev/v1/tiktok/profile?username=tiktok' \ -H 'X-API-Key: YOUR_KEY'Missing or invalid keys get a 401 with INVALID_API_KEY. Keep live keys
server-side, never call Fluxcrawl directly from a browser or mobile app
with a key embedded in the client.
What a key does
- Gates every request, no key, no response.
- Can be renamed, rotated, given its own credit limit, or revoked independently without affecting anyone else's key, from the API Keys page.
- Is never stored in reversible form: only its hash lives in the database, so a key is shown exactly once when it's created. Rotating a key keeps its name and credit limit but replaces the secret, the old one stops working immediately.
- Draws from your account's credit balance, see below.
Optional per-key credit limits
Give a key its own lifetime spend cap from the API Keys page, useful for handing a key to a script or a teammate without exposing your whole balance. Leave it unset and the key is bounded only by your account's balance.
Credits and billing
Every successful response reports what it cost:
{ "meta": { "credits_used": 1 } }Most endpoints cost 1 credit. List endpoints that cost more upstream cost
2: X posts, comments, search, discover, followers, following,
retweeters, and community, and Instagram followers, highlights,
stories, and location. Each platform page lists the cost per endpoint.
That amount is deducted from your account's balance the moment the call
succeeds. A provider failure never counts as billable usage: if Fluxcrawl's
fallback chain exhausts every provider for a platform/endpoint, you get a
PROVIDER_UNAVAILABLE error, not a charge. If your balance runs out before
the call is made, you get INSUFFICIENT_CREDITS instead, nothing is
attempted upstream. See Errors.
New accounts start with 150 free credits. After that, buy a one-time credit pack from the Billing page: Starter (3,000 credits, $15), Growth (12,000, $45), Scale (50,000, $149), or Pro (150,000, $399). Credits never expire.