gexbot api

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/json

Manage and generate API keys directly in the web portal:

Manage API Keys

Access Tiers

  • Public Endpoints: GET /tickers, GET /categories, and GET /v2/futures/conversion require 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:

HeaderDescription
X-RateLimit-LimitMaximum requests allowed in the current time window.
X-RateLimit-RemainingNumber of requests remaining in the current window.
X-RateLimit-ResetUnix 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:


Endpoint Groups

On this page