Quickstart

1. Get access

Sign up at gammaflip.io. You get a 3-day trial with API access included (50 requests/day). Every paid plan (Crypto, TradFi, Complete) gets 500 requests/day and up to 5 keys; see Authentication.

2. Create an API key

Log in at gammaflip.io/account
Open the menu → API Keys
Click Create API Key, give it a description
Copy the key — it’s shown only once

Your API key starts with gex_sk_ and is shown only once at creation. Save it somewhere secure (password manager, env var). If you lose it, you’ll need to create a new one.

3. Make your first request

List available exchanges (free: discovery calls don’t count against your quota):

curl https://api.gammaflip.io/api/v1/exchanges \
  -H "X-API-Key: gex_sk_your_key_here"

import requests

resp = requests.get(
    "https://api.gammaflip.io/api/v1/exchanges",
    headers={"X-API-Key": "gex_sk_your_key_here"},
)
print(resp.json())

const resp = await fetch("https://api.gammaflip.io/api/v1/exchanges", {
  headers: { "X-API-Key": "gex_sk_your_key_here" },
});
console.log(await resp.json());

Expected response:

{
  "data": {
    "available": ["bybit", "deribit", "okx", "derive", "binance", "tradfi"],
    "virtual": ["all"],
    "markets": {
      "crypto": ["deribit", "bybit", "okx", "derive", "binance"],
      "tradfi": ["tradfi"]
    }
  },
  "meta": {
    "timestamp": "2026-10-06T10:00:00+00:00"
  }
}

4. Get real GEX data

Fetch the GEX term structure for Bitcoin across all exchanges:

curl https://api.gammaflip.io/api/v1/gex/term-oi/all/BTC \
  -H "X-API-Key: gex_sk_your_key_here"

resp = requests.get(
    "https://api.gammaflip.io/api/v1/gex/term-oi/all/BTC",
    headers={"X-API-Key": "gex_sk_your_key_here"},
)
data = resp.json()["data"]
for exp in data["expirations"]:
    print(exp["date"], exp["total_gex"], exp["total_oi"])

5. Get the key levels in one call

/levels returns a small flat object (flip, regime, walls, totals) for the latest snapshot. Try a US ticker:

curl https://api.gammaflip.io/api/v1/levels/tradfi/QQQ \
  -H "X-API-Key: gex_sk_your_key_here"

Every response says how fresh it is (meta.as_of, meta.oi_as_of). Field definitions are in the data dictionary.

6. Check your rate limit

Counted responses (/gex/..., /levels/...) include these headers:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 498
X-RateLimit-Reset: 2026-04-15T00:00:00+00:00

When you hit the limit, you’ll get 429 Too Many Requests (with no Retry-After header; use X-RateLimit-Reset). Quota resets at midnight UTC every day. GET /me shows your quota for free.

The underlying GEX data updates every 15 minutes (from our Lambda capture). Polling more frequently than that doesn’t yield new data.

What’s next?

API Reference

Full reference for all endpoints, parameters, and response schemas.

Markets and exchanges

Crypto venues, TradFi tickers, subsets and expiration cutoffs.

Authentication

Learn about tiers, key management, and security best practices.

Rate Limits

How quotas work and how to handle 429 responses gracefully.

Getting Started

Concepts

1. Get access

2. Create an API key

3. Make your first request

4. Get real GEX data

5. Get the key levels in one call

6. Check your rate limit

What’s next?

API Reference

Markets and exchanges

Authentication

Rate Limits

​1. Get access

​2. Create an API key

​3. Make your first request

​4. Get real GEX data

​5. Get the key levels in one call

​6. Check your rate limit

​What’s next?

API Reference

Markets and exchanges

Authentication

Rate Limits

1. Get access

2. Create an API key

3. Make your first request

4. Get real GEX data

5. Get the key levels in one call

6. Check your rate limit

What’s next?