- Live API Reference
- Reference Essentials
- Reference Overview
FlashAlpha Lab API Reference: Endpoints, Fields, and Status Codes
Account management, system endpoints, field glossary, and complete endpoint index for the FlashAlpha Lab API.
ES=F (E-mini S&P 500) and NQ=F (E-mini Nasdaq-100) - URL-encode the = as %3D, e.g. /v1/exposure/gex/ES%3DF. Options-on-futures use Black-76 ($50/pt ES, $20/pt NQ); CME futures are Growth plan. See the futures hub.
Account, Symbols and Health Check Endpoints
Check your plan and quota, list the symbols with live data loaded, and monitor service health. Each endpoint has its own page with parameters, examples and a live Try It.
Reference & Account (7)
Supported tickers, option chain expirations and strikes, loaded and pre-warmed symbol lists, the VIX state, your account usage and service health.
/v1/universe
Public
Curated tier-1 and tier-2 symbols that stay pre-warmed, with 0DTE availability flags.
View docs →/v1/macro/vix-state
Growth+
Spot VIX against SPX 20-day realized vol, labelled overvixing, undervixing or neutral.
View docs →/health
Public
Service status, dependency checks and feed freshness. No authentication, not rate limited.
View docs →Options Data Field Glossary and Definitions
Comprehensive reference of all fields returned across the API.
| Field | Type | Description |
|---|---|---|
gamma_flip | number | Underlying price where aggregate repriced net GEX crosses zero (a continuous level, not a listed strike) - see gamma flip. Read it with gamma_flip_status: available means the level is certified and regime tells you which side dealers are on (above: long gamma, dampened moves; below: short gamma, amplified moves). Any other status means the level is shown but unverified and regime is unknown. Null when no supportable boundary exists. The most important single level for intraday traders. |
gamma_flip_status | string | available when the level is certified (coverage, expiry-day quote quality and single-strike stress checks passed at 0.1% or 0.25% of spot). sensitive_root, uncertain_root_path, quality_budget, uncertain_gamma_variance, insufficient_local_coverage or insufficient_quote_quality name the check an unverified level failed. Any other status (no_boundary, stored_sign_mismatch, immaterial_root, weak_shoulders, unresolved_search, one_sign_or_cancelled, no_priced_exposure and the data-integrity codes) means no supportable boundary; gamma_flip is null. |
net_gex | number | Net gamma exposure in USD notional across all strikes and expirations, normalised per 1% move. Positive = dealers buy dips/sell rips. Negative = dealers amplify moves. |
net_dex | number | Net delta exposure in USD notional. Directional bias indicator. Large positive DEX = dealers long delta (hedging puts). Large negative = dealers short delta (hedging calls). |
net_vex | number | Net vanna exposure in USD notional. Positive vanna benefits from IV compression (vol crush after events). Negative vanna amplifies directional moves when vol spikes. |
net_chex | number | Net charm exposure in USD notional. Drives end-of-day and overnight rebalancing flows. Positive charm = time decay pushes dealers to buy. Most relevant into weekly/monthly expiration. |
call_wall | number | Strike with the highest call-side GEX - see call wall. Acts as resistance - dealers sell delta as spot approaches. Breaks above the call wall often trigger accelerated upside moves. |
put_wall | number | Strike with the highest put-side GEX - see put wall. Acts as support - dealers buy delta as spot drops toward it. Breaks below can trigger cascading sell-side hedging. |
zero_dte_magnet | number | 0DTE strike with the highest gamma exposure. Acts as an intraday "pin" level - high-gamma 0DTE contracts cause intense dealer hedging that pulls price toward this strike, especially into the close. |
regime | string | Gamma regime: positive_gamma (range-bound, mean-reverting), negative_gamma (trending, breakout-prone), or unknown (no certified level, an unverified level, or spot sitting on the flip). Only certified levels drive the label. Use to set strategy bias: sell premium in positive, trade momentum in negative; treat unknown as no bias. |
implied_vol | number | Black-Scholes-Merton implied volatility. Computed from mid price using the BSM model (not sourced from exchange). Expressed as annualized decimal - 0.18 = 18% annualized vol. |
svi_vol | number | SVI-smoothed implied volatility using Gatheral's parametric surface fit. More stable than raw BSM IV for OTM strikes and illiquid contracts. Alpha plan only - returns null on lower plans, with svi_vol_gated: "requires_alpha_tier". |
svi_vol uses Gatheral's SVI parametric fit, one per expiry, to produce smooth, stable IV - ideal for pricing engines, vol surface construction, and Greeks computation. Alpha plan: upgrade to Alpha →
Greeks and open-interest fields:
| Field | Type | Description |
|---|---|---|
delta | number | Rate of change of option price per $1 move in underlying. Calls: 0 to 1, Puts: -1 to 0. Also approximates probability of finishing ITM. |
gamma | number | Rate of change of delta per $1 move. Highest near ATM and near expiry. The core input for GEX calculation - high gamma = intense dealer hedging. |
theta | number | Daily time decay in dollars. Negative for long options. Accelerates into expiry, especially for ATM 0DTE contracts. |
vega | number | Price change per 1-point move in IV. Highest on longer-dated ATM options. Key for vol trading and event plays. |
vanna | number | dDelta/dVol - cross-sensitivity of delta to volatility changes. Drives dealer hedging during VIX moves. The core input for VEX calculation. |
charm | number | dDelta/dTime - how delta changes as time passes. Drives end-of-day rebalancing flows. The core input for CHEX calculation. |
open_interest | number | Total open contracts at a given strike/expiry. Higher OI = more dealer hedging activity at that level. Changes in OI signal new positioning vs. closing of existing positions. |
call_oi_change / put_oi_change | number | Day-over-day OI change. Positive = new contracts opened (new positioning). Negative = contracts closed (unwinding). Combined with volume to distinguish opening from closing flows. |
Complete REST API Endpoint Index
Every endpoint in the FlashAlpha Lab API, grouped by family. Open a group to see its endpoints.
Market Data (2)
Exposure Analytics (15)
/v1/exposure/zero-dte/{symbol}
Growth+
0DTE analytics: pin risk, expected move, gamma acceleration
View docs →/v1/exposure/sheet/{symbol}
Growth+
Unified per-strike GEX/DEX/VEX/CHEX/DAG sheet + LIS + peaks
View docs →/v1/exposure/term-structure/{symbol}
Growth+
Per-greek exposure by DTE bucket and per expiry
View docs →/v1/exposure/expiry-impact/{symbol}
Growth+
Gamma concentration with one expiry excluded (SPY/QQQ)
View docs →/v1/exposure/strike-dependency/{symbol}
Growth+
One exact strike's gamma attributed to its expiries (SPY/QQQ)
View docs →/v1/exposure/oi-diff/{symbol}
Growth+
Day-over-day open-interest deltas, top changes
View docs →
Volatility Analytics (13)
/v1/volatility/skew-term/{symbol}
Growth+
Skew term structure: 25d/10d wings, risk reversal, butterfly
View docs →/v1/volatility/realized/{symbol}
Alpha+
Realized (historical) volatility series, multiple windows
View docs →/v1/liquidity/{symbol}
Growth+
Per-expiry + chain liquidity scores, spreads, OI depth
View docs →/v1/adv_volatility/{symbol}
Alpha+
SVI parameters, variance surface, arbitrage detection
View docs →
Flow Analytics (simulation-aware) (11)
Every endpoint in this group supports ?expiry=yyyy-MM-dd.
/v1/flow/levels/{symbol}
Growth+
Live gamma flip + call/put walls + max pain on effective OI
View docs →/v1/flow/pin-risk/{symbol}
Growth+
Live pin score (weighted 30% OI + 25% proximity + 25% time + 20% gamma)
View docs →/v1/flow/summary/{symbol}
Growth+
Headline flow direction, intraday OI delta, live GEX, % shift
View docs →/v1/flow/dealer-risk/{symbol}
Growth+
Settled vs live dealer GEX/DEX delta with direction classifier
View docs →/v1/flow/oi/{symbol}
Alpha+
Raw OI simulator state: official, simulated, effective, intraday delta, confidence
View docs →/v1/flow/signals/{symbol}
Alpha+
Scored, classified unusual-flow feed: sweep/block, NBBO aggressor, opening bias, intent, 0-100 score with breakdown
View docs →/v1/flow/signals/{symbol}/summary
Alpha+
Net bullish/bearish + opening/closing premium roll-up + top 10 signals
View docs →/v1/flow/options/{symbol}/dealer-premium
Alpha+
Full-tape Net Dealer Premium roll-up over a window
View docs →
0DTE Flow (intraday, effective OI) (5)
/v1/flow/zero-dte/hedge-flow/{symbol}
Growth+
Dealer hedge-flow time series, per-bar + cumulative
View docs →/v1/flow/zero-dte/strike-flow/{symbol}
Alpha+
Per-strike signed aggressor flow per bar
View docs →
Trade Flow Data (trade tape proxy, camelCase, Alpha+) (16)
/v1/flow/options/{symbol}/recent
Alpha+
Recent option trades by underlying, newest first
View docs →/v1/flow/options/{symbol}/summary
Alpha+
Buy/sell/mid/net contract volume totals by underlying
View docs →/v1/flow/options/{symbol}/blocks
Alpha+
Large option trades filtered by min contract size
View docs →/v1/flow/options/{symbol}/history
Alpha+
Minute option-flow buckets with VWAP, high/low
View docs →/v1/flow/options/{symbol}/option-minute-history
Alpha+
Per-contract (strike + right + expiry) minute buy/sell/mid classified volume; sum buys minus sells per strike for net customer flow
View docs →/v1/flow/stocks/{symbol}/bars
Alpha+
Multi-resolution OHLCV + flow bars from the live tape
View docs →/v1/flow/options/leaderboard
Alpha+
Cross-symbol option-flow buyers/sellers by net notional (refreshed every 30 s)
View docs →/v1/flow/options/outliers
Alpha+
Cross-symbol option-flow outliers with imbalance, skew
View docs →
Strategy Signals (decision envelope) (11)
/v1/strategies/flow-anomaly/{symbol}
Growth+
Directional options-flow imbalance signal
View docs →/v1/strategies/sell-window/{symbol}
Basic now, Growth from Dec 1
Should you sell options today? Built from more than 5 million backtests: sell or skip per expiry for SPY, QQQ and IWM, plus suggested positions. Backtestable on Alpha.
View docs →/v1/strategies/yield-enhancement/{symbol}
Growth+
Covered-call / cash-secured-put overlay
View docs →/v1/strategies/surface-anomaly/{symbol}
Alpha+
SVI residual rich/cheap wing detection
View docs →
Earnings (8)
Structures (pure-math, no market lookup) (2)
Screener & Pricing (13)
/v1/stock/{symbol}/summary
Public
Stock summary (previous session without a key / live with one)
View docs →HTTP Status Codes and Error Response Reference
| Status | Description |
|---|---|
200 | Success |
400 | Bad request - invalid parameters ({error, message}), or an RFC 7807 problem-details body when a value has the wrong type |
401 | Unauthorized - invalid or missing API key. Empty body |
403 | Tier restricted - your plan does not include this endpoint, symbol or parameter (tier_restricted, with current_plan and required_plan). On Free, a stock outside the tracked universe returns symbol_not_in_free_universe |
404 | Not found - symbol not tracked or no data (no_data, symbol_not_found and route-specific codes, see Errors) |
405 | Method not allowed - empty body |
422 | Unprocessable - the value cannot be computed, for example an option price outside the arbitrage-free range (iv_not_found), or a symbol the operation does not support (unsupported_symbol) |
429 | Rate limited - daily quota exceeded (Quota exceeded, Retry-After in seconds). Requests rejected with 403 count toward the quota |
500 | Internal server error |
503 | Service unavailable - upstream service temporarily unavailable, or a disabled source (historical_source_unhealthy) |
504 | Gateway timeout - HTML body, Retry-After: 120; retry later |
Get Started
Unlock DEX, VEX and CHEX with Basic
Everything in Free, plus:
- DEX, VEX and CHEX exposure
- Full max pain
- ETF & index symbols SPY, QQQ, SPX, VIX
Go full-chain with Growth
Everything in Basic, plus:
- Full-chain GEX Every expiration
- 0DTE analytics
- Exposure summary & AI narrative
- CME futures & live screener
Add history and vol surfaces with Alpha
Everything in Growth, plus:
- Historical API replay Since 2017
- SVI vol surfaces
- VRP analytics
- Greeks surfaces Vanna, charm, volga and speed grids