API Reference: Endpoints, Field Glossary, and Status Codes | FlashAlpha
  1. 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.

CME futures are supported. Every per-symbol endpoint below also accepts 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.

GET /v1/tickers Free+

Every stock and ETF ticker the API supports.

View docs →
GET /v1/options/{ticker} Free+

Expirations and strikes for a symbol's option chain.

View docs →
GET /v1/symbols Free+

Symbols that have been queried and have live data loaded.

View docs →
GET /v1/universe Public

Curated tier-1 and tier-2 symbols that stay pre-warmed, with 0DTE availability flags.

View docs →
GET /v1/macro/vix-state Growth+

Spot VIX against SPX 20-day realized vol, labelled overvixing, undervixing or neutral.

View docs →
GET /v1/account Free+

Your plan, daily limit, usage today and quota reset time.

View docs →
GET /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_flipnumberUnderlying 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_statusstringavailable 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_gexnumberNet 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_dexnumberNet delta exposure in USD notional. Directional bias indicator. Large positive DEX = dealers long delta (hedging puts). Large negative = dealers short delta (hedging calls).
net_vexnumberNet vanna exposure in USD notional. Positive vanna benefits from IV compression (vol crush after events). Negative vanna amplifies directional moves when vol spikes.
net_chexnumberNet 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_wallnumberStrike 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_wallnumberStrike 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_magnetnumber0DTE 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.
regimestringGamma 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_volnumberBlack-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_volnumberSVI-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".
Why SVI-smoothed IV? Raw BSM IV can be noisy or undefined for deep OTM strikes and illiquid contracts. 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:

FieldTypeDescription
deltanumberRate of change of option price per $1 move in underlying. Calls: 0 to 1, Puts: -1 to 0. Also approximates probability of finishing ITM.
gammanumberRate of change of delta per $1 move. Highest near ATM and near expiry. The core input for GEX calculation - high gamma = intense dealer hedging.
thetanumberDaily time decay in dollars. Negative for long options. Accelerates into expiry, especially for ATM 0DTE contracts.
veganumberPrice change per 1-point move in IV. Highest on longer-dated ATM options. Key for vol trading and event plays.
vannanumberdDelta/dVol - cross-sensitivity of delta to volatility changes. Drives dealer hedging during VIX moves. The core input for VEX calculation.
charmnumberdDelta/dTime - how delta changes as time passes. Drives end-of-day rebalancing flows. The core input for CHEX calculation.
open_interestnumberTotal 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_changenumberDay-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)

GET /stockquote/{ticker} Free+

Live stock quote

View docs →
GET /optionquote/{ticker} Growth+

Option quotes with greeks

View docs →

Exposure Analytics (15)

GET /v1/exposure/gex/{symbol} Free+

Gamma exposure by strike

View docs →
GET /v1/exposure/dex/{symbol} Basic+

Delta exposure by strike

View docs →
GET /v1/exposure/vex/{symbol} Basic+

Vanna exposure by strike

View docs →
GET /v1/exposure/chex/{symbol} Basic+

Charm exposure by strike

View docs →
GET /v1/exposure/summary/{symbol} Growth+

Full exposure summary

View docs →
GET /v1/exposure/levels/{symbol} Free+

Key support/resistance levels

View docs →
GET /v1/exposure/narrative/{symbol} Growth+

Verbal narrative analysis

View docs →
GET /v1/exposure/zero-dte/{symbol} Growth+

0DTE analytics: pin risk, expected move, gamma acceleration

View docs →
GET /v1/maxpain/{symbol} Basic+

Max pain strike, pain curve, pin probability

View docs →
GET /v1/exposure/sheet/{symbol} Growth+

Unified per-strike GEX/DEX/VEX/CHEX/DAG sheet + LIS + peaks

View docs →
GET /v1/exposure/term-structure/{symbol} Growth+

Per-greek exposure by DTE bucket and per expiry

View docs →
GET /v1/exposure/expiry-impact/{symbol} Growth+

Gamma concentration with one expiry excluded (SPY/QQQ)

View docs →
GET /v1/exposure/strike-dependency/{symbol} Growth+

One exact strike's gamma attributed to its expiries (SPY/QQQ)

View docs →
GET /v1/exposure/oi-diff/{symbol} Growth+

Day-over-day open-interest deltas, top changes

View docs →
GET /v1/exposure/basket Growth+

Weighted cross-symbol GEX/DEX/VEX/CHEX aggregate

View docs →

Volatility Analytics (13)

GET /v1/volatility/{symbol} Growth+

Realized vol, IV-RV spreads, skew, term structure

View docs →
GET /v1/volatility/skew-term/{symbol} Growth+

Skew term structure: 25d/10d wings, risk reversal, butterfly

View docs →
GET /v1/volatility/spot-vol-correlation/{symbol} Growth+

20d/60d spot-vol correlation

View docs →
GET /v1/volatility/realized/{symbol} Alpha+

Realized (historical) volatility series, multiple windows

View docs →
GET /v1/volatility/forecast/{symbol} Alpha+

Forward volatility regime forecast

View docs →
GET /v1/liquidity/{symbol} Growth+

Per-expiry + chain liquidity scores, spreads, OI depth

View docs →
GET /v1/expected-move/{symbol} Basic+

Straddle-implied expected move per expiry

View docs →
GET /v1/adv_volatility/{symbol} Alpha+

SVI parameters, variance surface, arbitrage detection

View docs →
GET /v1/surface/svi/{symbol} Alpha+

Live SVI parameters per expiry

View docs →
GET /v1/dispersion Alpha+

Implied vs realized correlation across an index basket

View docs →
GET /v1/macro/vix-state Growth+

VIX vs SPX-realized regime classifier

View docs →
GET /v1/vrp/{symbol} Alpha+

VRP dashboard: z-score, directional VRP, strategy scores

View docs →
GET /v1/vrp/{symbol}/history Alpha+

Daily VRP time series for charting/backtesting

View docs →

Flow Analytics (simulation-aware) (11)

Every endpoint in this group supports ?expiry=yyyy-MM-dd.

GET /v1/flow/levels/{symbol} Growth+

Live gamma flip + call/put walls + max pain on effective OI

View docs →
GET /v1/flow/pin-risk/{symbol} Growth+

Live pin score (weighted 30% OI + 25% proximity + 25% time + 20% gamma)

View docs →
GET /v1/flow/summary/{symbol} Growth+

Headline flow direction, intraday OI delta, live GEX, % shift

View docs →
GET /v1/flow/gex/{symbol} Growth+

Live net GEX + per-strike profile on effective OI

View docs →
GET /v1/flow/dex/{symbol} Growth+

Live net DEX + per-strike profile on effective OI

View docs →
GET /v1/flow/dealer-risk/{symbol} Growth+

Settled vs live dealer GEX/DEX delta with direction classifier

View docs →
GET /v1/flow/oi/{symbol} Alpha+

Raw OI simulator state: official, simulated, effective, intraday delta, confidence

View docs →
GET /v1/flow/live/{symbol} Alpha+

Headline flow bundle in one call

View docs →
GET /v1/flow/signals/{symbol} Alpha+

Scored, classified unusual-flow feed: sweep/block, NBBO aggressor, opening bias, intent, 0-100 score with breakdown

View docs →
GET /v1/flow/signals/{symbol}/summary Alpha+

Net bullish/bearish + opening/closing premium roll-up + top 10 signals

View docs →
GET /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)

GET /v1/flow/zero-dte/snapshot/{symbol} Growth+

Live 0DTE shape + flow_direction block

View docs →
GET /v1/flow/zero-dte/series/{symbol} Growth+

Intraday 0DTE flow time series

View docs →
GET /v1/flow/zero-dte/hedge-flow/{symbol} Growth+

Dealer hedge-flow time series, per-bar + cumulative

View docs →
GET /v1/flow/zero-dte/heatmap/{symbol} Alpha+

Per-strike value matrix (strike x time)

View docs →
GET /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)

GET /v1/flow/options/{symbol}/recent Alpha+

Recent option trades by underlying, newest first

View docs →
GET /v1/flow/options/{symbol}/summary Alpha+

Buy/sell/mid/net contract volume totals by underlying

View docs →
GET /v1/flow/options/{symbol}/blocks Alpha+

Large option trades filtered by min contract size

View docs →
GET /v1/flow/options/{symbol}/history Alpha+

Minute option-flow buckets with VWAP, high/low

View docs →
GET /v1/flow/options/{symbol}/cumulative Alpha+

Running cumulative net option flow

View docs →
GET /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 →
GET /v1/flow/stocks/{symbol}/recent Alpha+

Recent stock trades by symbol

View docs →
GET /v1/flow/stocks/{symbol}/summary Alpha+

Stock buy/sell/mid/net share volume totals

View docs →
GET /v1/flow/stocks/{symbol}/blocks Alpha+

Large stock trades

View docs →
GET /v1/flow/stocks/{symbol}/history Alpha+

Minute stock-flow buckets with VWAP, OHLC

View docs →
GET /v1/flow/stocks/{symbol}/cumulative Alpha+

Running cumulative net stock flow

View docs →
GET /v1/flow/stocks/{symbol}/bars Alpha+

Multi-resolution OHLCV + flow bars from the live tape

View docs →
GET /v1/flow/options/leaderboard Alpha+

Cross-symbol option-flow buyers/sellers by net notional (refreshed every 30 s)

View docs →
GET /v1/flow/options/outliers Alpha+

Cross-symbol option-flow outliers with imbalance, skew

View docs →
GET /v1/flow/stocks/leaderboard Alpha+

Cross-symbol stock-flow leaderboard

View docs →
GET /v1/flow/stocks/outliers Alpha+

Cross-symbol stock-flow outliers

View docs →

Strategy Signals (decision envelope) (11)

GET /v1/strategies/flow-anomaly/{symbol} Growth+

Directional options-flow imbalance signal

View docs →
GET /v1/strategies/expiry-positioning/{symbol} Basic+

OPEX pin-risk / iron-fly setup

View docs →
GET /v1/strategies/zero-dte/{symbol} Growth+

Same-day range-compression read (0DTE)

View docs →
GET /v1/strategies/dealer-regime/{symbol} Growth+

Dealer gamma regime classifier

View docs →
GET /v1/strategies/vol-carry/{symbol} Alpha+

VRP carry credit-spread selection

View docs →
GET /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 →
GET /v1/strategies/yield-enhancement/{symbol} Growth+

Covered-call / cash-secured-put overlay

View docs →
GET /v1/strategies/surface-anomaly/{symbol} Alpha+

SVI residual rich/cheap wing detection

View docs →
GET /v1/strategies/skew/{symbol} Growth+

25-delta skew / risk-reversal signal

View docs →
GET /v1/strategies/term-structure/{symbol} Growth+

ATM-IV term-structure signal

View docs →
GET /v1/strategies/tail-pricing/{symbol} Growth+

Downside-tail richness signal

View docs →

Earnings (8)

GET /v1/earnings/calendar Growth+

Upcoming earnings calendar

View docs →
GET /v1/earnings/expected-move/{symbol} Growth+

Earnings-implied move decomposition

View docs →
GET /v1/earnings/history/{symbol} Growth+

Past surprises, moves, IV crush

View docs →
GET /v1/earnings/iv-crush/{symbol} Growth+

Expected + historical IV-crush distribution

View docs →
GET /v1/earnings/vrp/{symbol} Alpha+

Earnings vol-risk-premium (implied vs realized)

View docs →
GET /v1/earnings/dealer-positioning/{symbol} Alpha+

Event-scoped dealer exposure

View docs →
GET /v1/earnings/strategies/{symbol} Alpha+

Earnings strategy-suitability scores

View docs →
GET /v1/earnings/screener Alpha+

Cross-sectional earnings screener

View docs →

Structures (pure-math, no market lookup) (2)

POST /v1/structures/pnl Basic+

At-expiry P&L curve + breakevens

View docs →
POST /v1/structures/greeks Basic+

Aggregate position greeks

View docs →

Screener & Pricing (13)

POST /v1/screener Growth+

Real-time multi-factor options screener across ~250 symbols

View docs →
GET /v1/screener/fields Growth+

List queryable screener fields + types

View docs →
GET /v1/pricing/greeks Free+

Full BSM greeks (delta through ultima)

View docs →
GET /v1/pricing/iv Free+

Implied volatility solver (Newton-Raphson)

View docs →
GET /v1/pricing/kelly Growth+

Kelly criterion position sizing

View docs →
GET /v1/stock/{symbol}/summary Public

Stock summary (previous session without a key / live with one)

View docs →
GET /v1/surface/{symbol} Public

Vol surface grid

View docs →
GET /v1/options/{ticker} Free+

Option chain metadata

View docs →
GET /v1/tickers Free+

All available ticker symbols

View docs →
GET /v1/account Free+

Account info & usage

View docs →
GET /v1/symbols Free+

Tracked symbols

View docs →
GET /v1/universe Public

Curated tier-1/tier-2 pre-warmed symbol directory

View docs →
GET /health Public

Health check

View docs →

HTTP Status Codes and Error Response Reference

Status Description
200Success
400Bad request - invalid parameters ({error, message}), or an RFC 7807 problem-details body when a value has the wrong type
401Unauthorized - invalid or missing API key. Empty body
403Tier 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
404Not found - symbol not tracked or no data (no_data, symbol_not_found and route-specific codes, see Errors)
405Method not allowed - empty body
422Unprocessable - 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)
429Rate limited - daily quota exceeded (Quota exceeded, Retry-After in seconds). Requests rejected with 403 count toward the quota
500Internal server error
503Service unavailable - upstream service temporarily unavailable, or a disabled source (historical_source_unhealthy)
504Gateway timeout - HTML body, Retry-After: 120; retry later

Ready to build with FlashAlpha?

Get your free API key and start pulling live options data in 60 seconds.

No credit card required Setup in 60 seconds Secure & reliable