Skip to main content

API Key Authentication

All /v1/* API requests require an AtlasFlux API key in the Authorization header.

Header format

or for test keys:

Key types

Creating an API key

  1. Go to Dashboard → API Keys
  2. Click Create API key
  3. Choose environment (test or live)
  4. Copy the key immediately — it will not be shown again

Storing your key

Always store your API key as an environment variable. Never hardcode it in source code or expose it in browser/client-side code.
In your application:
Never expose your API key in browser JavaScript, mobile apps, or client-side code. API keys grant access to your wallet balance. Use them only in server-side environments.

Key rotation

If your key is compromised:
  1. Go to Dashboard → API Keys
  2. Delete or revoke the compromised key
  3. Create a new key
  4. Update your application with the new key

Revoked or invalid keys

Requests with revoked, expired, or invalid keys receive a 401 Unauthorized response:

Rate limits

API keys have rate limits based on environment: Rate limit headers are included in every response:
  • x-ratelimit-limit — Maximum requests per window
  • x-ratelimit-remaining — Remaining requests
  • x-ratelimit-reset — Unix timestamp when the window resets