Skip to main content

Obtain API Key

  1. Create an API key in the Enso Developer Portal.
  2. Store it in an environment variable. Never commit the key to source control.

Authenticate requests

Pass your API key using either:
  • The Authorization: Bearer <API_KEY> header.
  • The apikey=<API_KEY> query parameter.

Test your API key

Use the authenticated account endpoint to verify the key without building a transaction:
Next, choose between the Route API and Bundle API.

Rate Limiting

API calls are limited to 10 RPS (600 requests per minute). It can be increased on demand. If you exceed the limit, you’ll receive a 429 Too Many Requests error. If your monthly API credits quota is exceeded, requests also return 429 Too Many Requests. Rate limit and quota errors include a portalUrl field that points to the Developer Portal for key management and plan upgrades.

Credit Usage Headers

API responses include headers that report API credit usage, so you can track the cost of each call and watch your monthly quota. Requests rejected before they are processed (invalid key, rate limit, or exceeded quota) are not charged and do not include x-enso-credits-request.

Auth Errors

Invalid API keys return 401 Unauthorized with error: "invalid_api_key". Retired legacy keys return 401 Unauthorized with error: "legacy_key_retired". Both responses include a portalUrl field so clients can direct users to create or recover an API key in the Developer Portal. Blocked accounts return 403 Forbidden with error: "account_blocked" and a message that API access is disabled.

Updated 2026-11-07