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.

This guide takes you from “I have an account” to “I have a working integration” in five steps.
1

Get your API key

Sign in at backquant.com/api-access and create a key. Your key looks like:
bq_live_<32-character-token>
2

Make your first call

Hit the composable GEX levels endpoint for BTC. Replace YOUR_API_KEY with your actual key:
curl "https://api.backquant.com/v2/gex/levels?symbol=BTCUSDT" \
  -H "X-API-Key: YOUR_API_KEY"
3

Read the envelope

Every response uses the same envelope. A successful call returns:
{
  "success": true,
  "data": {
    "all_expiry": {
      "hvl": 67000,
      "call_resistance": 70000,
      "call_wall_2": 72500,
      "call_wall_3": 75000,
      "put_support": 64000,
      "put_wall_2": 60000,
      "put_wall_3": 58000
    },
    "odte": {
      "hvl": 67500,
      "call_resistance": 68000,
      "put_support": 66500
    }
  },
  "meta": {
    "version": "2.0",
    "timestamp": "2026-04-30T12:00:00.123Z",
    "request_id": "req_a1b2c3...",
    "symbol": "BTCUSDT",
    "spot_price": 67213.5,
    "computed_at": "2026-04-30T11:59:48.000Z",
    "freshness_seconds": 12.0,
    "source": ["deribit", "bybit", "okx", "binance"]
  }
}
Always check success before reading data. On failure you get success: false and an error object instead — see Errors for the full code list.The meta block tells you how stale the data is (freshness_seconds), which venues it came from (source), and the spot price at the time of computation (spot_price). Use request_id when reporting issues.
4

Add a filter or include

Most endpoints support filters. Here’s the same call with the composable ?include= parameter and an exchange filter:
curl "https://api.backquant.com/v2/gex/levels?\
symbol=BTCUSDT\
&exchanges=deribit,bybit\
&include=ranked,max_pain,expected_move,zones" \
  -H "X-API-Key: YOUR_API_KEY"
Now the response includes the top-10 ranked strikes by |GEX|, the 0DTE max-pain strike, the 1σ/2σ expected move from ATM straddles, and the gamma flip zones — in one call.Common filters you’ll use across the API:
  • ?symbol=BTCUSDT|ETHUSDT|SOLUSDT|HYPEUSDT — supported symbols
  • ?exchanges=deribit,bybit,okx,binance — venue filter
  • ?expiry=all|0dte|<token> — single expiry slice
  • ?dte_min / ?dte_max / ?weekly_only=true — DTE-axis filter
  • ?moneyness_min / ?moneyness_max — strike/spot ratio bounds
  • ?include=... — opt-in to optional response sections
  • ?fields=... — top-level projection on heavy endpoints
5

Try the OPEX calendar

For a more product-y example, get the next 30 days of options expirations with their classification, OI, walls, and max-pain in one call:
curl "https://api.backquant.com/v2/options/opex?symbol=BTCUSDT&horizon=30" \
  -H "X-API-Key: YOUR_API_KEY"
The response gives you a ranked calendar of upcoming expirations, each tagged daily | weekly | monthly | quarterly, with the next monthly/quarterly anchor highlighted under next_anchor. See the OPEX concept page for what these mean and how to use them.

What is GEX?

The single most-asked concept question. Read this before integrating.

Response format

Full envelope schema, every meta field explained.

Rate limits

Per-tier limits, response headers, retry strategy.

Code examples

Python, TypeScript, curl recipes for common workflows.

OPEX calendar

Daily/weekly/monthly/quarterly classification, anchor expirations.

API reference

All 38 endpoints, with interactive try-it-out.