
Search
Helios uses API keys and request signing to authenticate and authorize requests.
All requests must be authenticated before reaching execution or simulation layers.
API Keys
Each Helios account is issued one or more API keys.
API keys identify your application
Keys should be kept secret
Separate keys are recommended per environment
API keys are passed via the Authorization header.
Request Signing
In addition to API keys, Helios requires request signing to ensure integrity and prevent replay attacks.
Each request is signed using:
Request payload
Timestamp
Your API secret
Example: Signing a Request (Node.js)
Attach both the timestamp and signature as headers.
Requests without valid signatures are rejected.
Permission Scopes
API keys are scoped to limit access.
Common scopes include:
simulate:readexecute:writeroutes:readrisk:read
Scopes are enforced at request time.
Requests using insufficient permissions return 403 Forbidden.
Example: Scoped Key Usage
Rate Limits
Rate limits are enforced per API key.
Limits vary by:
Environment
Endpoint type
Account tier
When a rate limit is exceeded, the API returns:
Rate limit headers are included in every response.
Clients should implement retries with backoff.
Environments
Helios provides isolated environments for development and production.
testnet— for testing and simulationsmainnet— for live execution
Environment selection is configured at client initialization.
Keys are environment-specific and cannot be reused across environments.
Authentication Errors
Authentication failures return explicit error codes.
Common causes include:
Missing headers
Incorrect signatures
Expired timestamps
Insufficient scopes