Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.backquant.com/llms.txt

Use this file to discover all available pages before exploring further.

Every BackQuant API request requires an API key passed in the X-API-Key header. Keys are tied to your subscription tier and control your rate limits.

​
Get an API key

Get your API key

Sign up or sign in at backquant.com/api-access to create and manage your keys.

​
Pass your API key

Include your key in the X-API-Key header on every request. 
curl https://api.backquant.com/v2/gex/levels?symbol=BTCUSDT \
  -H "X-API-Key: bq_live_your_api_key_here"
API keys follow this format: 
bq_live_<32-character-token>
Keep your API key secret. Do not commit it to source control or expose it in client-side code. If your key is compromised, rotate it immediately at backquant.com/api-access.

​
Endpoints that don’t require auth

A small set of endpoints are intentionally public so you can introspect the API before signing up:
EndpointPurpose
/v2/openapi.jsonFull machine-readable OpenAPI 3 spec
/v2/docsSwagger UI — interactive playground
/v2/redocReDoc — alternative reference renderer
/v2/healthLiveness/readiness probe for monitors
Every other route requires X-API-Key.

​
Authentication errors

A missing or invalid API key returns a 401 response with the UNAUTHORIZED error code: 
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing X-API-Key header"
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-30T12:00:00Z",
    "request_id": "req_..."
  }
}
Common causes:
  • The X-API-Key header is missing from the request.
  • The key value has a leading/trailing space (common when copy-pasting).
  • The key was revoked at backquant.com/api-access.
  • Your subscription lapsed (FORBIDDEN rather than UNAUTHORIZED in this case).
The request_id field in the meta block is the value of the X-Request-ID header — include it when reporting auth issues so we can trace the specific call in our logs.

​
Next steps

Quick start

Make your first API call.

Code examples

Python, TypeScript, and curl recipes.

Rate limits

Per-tier limits and backoff strategy.

Errors

Every error code with handling examples.