gexbot-openapi

The NFA gexbot OpenAPI Specification.

overview

This repository contains the OpenAPI 3.0.1 specification for the NFA gexbot API, which provides options-derived market data including GEX (Gamma Exposure), greeks, and orderflow metrics.

spec

• YAML
• JSON

base url

https://api.gex.bot/v2

authentication

All endpoints (except /tickers) require a valid gexbot API key in the Authorization header.

endpoints

Endpoint	Description
/{ticker}/classic/{category}	Classic GEX chart data
/{ticker}/state/{category}	State greeks chart data
/{ticker}/orderflow/orderflow	Orderflow metrics
/{ticker}/classic/{category}/majors	Key GEX levels (classic)
/{ticker}/state/{category}/majors	Key GEX levels (state)
/{ticker}/classic/{category}/maxchange	Max GEX change by lookback (classic)
/{ticker}/state/{category}/maxchange	Max GEX change by lookback (state)
/tickers	List available ticker symbols
/hist/{ticker}/{package}/{category}/{date}	Download historical data
/negotiate	Negotiate WebSocket connection

example

Request

GET https://api.gex.bot/v2/SPX/classic/gex_full
Authorization: Bearer gexbot_custom_<your-api-key-secret>
User-Agent: my-app/1.0
Accept: application/json

Note: Your API key must include both the prefix gexbot_custom_ and your secret key in the Authorization header (e.g., gexbot_custom_your-secret-key).

Response

{
  "timestamp": 1777492800,
  "ticker": "SPX",
  "min_dte": 0,
  "sec_min_dte": 1,
  "spot": 7138.55,
  "zero_gamma": 7112.95,
  "major_pos_vol": 7135,
  "major_pos_oi": 7200,
  "major_neg_vol": 7100,
  "major_neg_oi": 6900,
  "strikes": [
    [6890,-228.01,-86.9,[-240.55,-243.15,-245.22,-221.27,-220.12]],
    [6895,-48.47,69.76,[-49.05,-46.76,-45.55,-45.53,-42.97]],
    // Trimmed for brevity
    [7380,44.16,75.99,[0,47.7,47.3,0,40.55]],
    [7385,5.5,14.27,[0,0,0,0,0]]],
  "sum_gex_vol": 1712585.519,
  "sum_gex_oi": 51521.105,
  "delta_risk_reversal": 0.118,
  "max_priors": [
    [7140,170979.742],
    [7135,1145886.722],
    [7135,997473.336],
    [7135,1106210.715],
    [7135,1128504.809],
    [7135,1131150.488]
  ]
}

subscription tiers

Subscriptions are available for different data packages at https://www.gexbot.com/:

• Classic — Classic GEX data
• State — State greeks data
• Orderflow — Orderflow metrics
• Quant — Full access including historical data and WebSocket feeds

related repositories

• quant-python-sockets — Python client for real-time WebSocket feeds
• quant-historical — Historical data download examples

links

• gexbot.com
• Terms and Conditions