overview
REST and WebSocket API for live gexbot options data.
The gexbot API delivers real-time options analytics — including Gamma Exposure (GEX), Delta Exposure (DEX), second-order Greeks (Vanna, Charm, Convexity), classified orderflow, research charts, and streaming WebSockets — over standard REST and WebSocket protocols.
Authentication
All authenticated requests require an API key passed in the Authorization header as a Bearer token, along with a descriptive User-Agent:
Authorization: Bearer <YOUR_API_KEY>
User-Agent: <YOUR_APP_NAME>/1.0
Accept: application/jsonManage and generate API keys directly in the web portal:
Manage API KeysAccess Tiers
- Public Endpoints:
GET /tickers,GET /categories, andGET /v2/futures/conversionrequire no authentication or subscription. - Package-Gated Endpoints: Core endpoints require an active subscription corresponding to the package (Classic, State, Orderflow, Quant, or Research).
- Daily EOD Reports: All active subscriptions include programmatic access to
GET /hist/eod/{TICKER}.
Rate Limits & Quotas
gexbot applies tiered query quotas and concurrency limits to maintain low-latency infrastructure for all users.
Policy & Reset Schedule
- Endpoint Isolation: Quotas track independently per endpoint. Exceeding a limit on one endpoint does not block your key on other endpoints or live WebSockets.
- Midnight ET Rollover: Daily quotas reset every night at 12:00 AM ET (Midnight Eastern Time) to align with US trading session boundaries.
- Market Hours (NYSE RTH): Spot prices, trade classifications, and live calculation feeds operate from 9:30 AM to 4:00 PM ET. GEX by Open Interest refreshes daily at 8:30 AM ET.
- Server Calculation Frequency: Live calculations refresh at most once per second (1/sec) during market hours. Polling a single ticker more frequently than 1/second returns identical data.
- Email Notifications: On the first breach of an endpoint quota, gexbot sends an alert to your registered account email (maximum 1 notification per endpoint per window).
Rate Limit Headers
All API responses include standard rate limit headers:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum requests allowed in the current time window. |
X-RateLimit-Remaining | Number of requests remaining in the current window. |
X-RateLimit-Reset | Unix timestamp when the rate limit window resets. |
Handling 429 Responses
When you exceed a rate limit quota, the server returns HTTP 429 Too Many Requests:
{
"error": "Rate limit exceeded."
}Use exponential backoff or inspect the Retry-After header before retrying.
Developer Resources & OpenAPI
Use official specifications, schemas, and client libraries to accelerate your integration:
OpenAPI Specification
Official OpenAPI 3.0.1 specification (YAML/JSON) for REST and research endpoints.
Python WebSocket SDK
Runnable Python client, Protocol Buffer schemas, and zstd decompression helpers.
Historical Data Downloader
Sample Python scripts and utilities for bulk historical snapshot data download and parsing.
Endpoint Groups
general
Public tickers, Quant streaming tickers, package categories, option expiries, futures conversion, and EOD reports.
classic
GEX by OI & volume, zero gamma boundary, major levels, and max change priors.
state
State GEX profile, options profile (OP), delta/convexity ladders, and decay flows.
orderflow
Classified time-series order flow, delta footprints, and aggregate trade metrics.
quant
Low-latency WebSocket streaming and bulk historical snapshot archives.
research
On-demand gbR chart rendering, 3D volatility surfaces, and CSV/JSON datasets.