Quickstart

First API call in 30 seconds

Quickstart

Go from zero to live gamma data in under 30 seconds. This guide walks you through authentication, your first API call, response parsing, and real-time streaming.

Step 1: Get Your API Key

Create an API key from your dashboard. Navigate to Dashboard → API Keys or go directly to /dashboard/api-keys. Click Create Key, give it a name, and copy the key. You will not be able to see the full key again after creation.

Step 2: Make Your First Request

All API requests require the X-API-Key header. The simplest call fetches gamma exposure for SPX:

Step 3: Parse the Response

All endpoints return a JSON envelope with these top-level fields:

Positive total_gex indicates a positive gamma environment where dealers suppress volatility. Negative total GEX indicates dealers will amplify moves.

Step 4: Real-Time Streaming

For live updates, connect to the WebSocket endpoint. You will receive updates whenever the engine recomputes (approximately every second during market hours).

After connecting, send a subscription message specifying the channels you want. Available channels include gex, signals, regime, and levels.