Skip to main content

Authentication

API Key​

All Atomic Vaults API endpoints are authenticated using an API key passed in the X-API-KEY HTTP header.

X-API-KEY: your-api-key

Your API key is issued during the partner onboarding process. Contact the Atomic Vaults team to obtain your credentials.

Usage​

Base URL Placeholder

Code examples on this page use {BASE_URL} as a placeholder. Replace it with the actual endpoint for your market and environment. See Environments & Base URLs for all available endpoints.

Include the header in every request:

curl -H "X-API-KEY: your-api-key" \
  {BASE_URL}/balances
const response = await fetch("{BASE_URL}/balances", {
  headers: {
    "X-API-KEY": "your-api-key",
  },
});
import requests

response = requests.get(
    "{BASE_URL}/balances",
    headers={"X-API-KEY": "your-api-key"},
)

Security Best Practices​

  • Never expose your API key in client-side code or public repositories
  • Rotate your API key periodically
  • Use environment variables to store the key in your application
  • Restrict API key access to specific IP ranges where possible

Environments​

Authentication works the same across all markets and environments. See Environments & Base URLs for the complete list of endpoints.