API Key
Authentication
All requests to the Alphractal API require authentication using an API key.
The API key must be included in every request as an HTTP header:
X-Api-Key: YOUR_API_KEY
Requests without a valid API key will be rejected.
How to get an API key
-
Log in to your Alphractal account.
-
Navigate to the API section in your dashboard.
-
Generate a new API key.
Each API key is unique to your account and determines:
-
Access level (plan / tier)
-
Available endpoints
-
Credit limits and rate limits
Security best practices
-
Treat your API key as a secret.
-
Do not expose it in client-side code, public repositories, or frontend applications.
-
Use environment variables or secure key management systems when deploying.
If an API key is compromised, rotate it immediately from the dashboard.
Key scope and limits
-
API keys are account-based, not asset-based.
-
Usage is tracked per key.
-
Requests count against your available API credits.
Details about credit usage and limits are explained in the next section.