Name: FlashAlpha Lab API
Author: FlashAlpha

CME index 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 index futures are Growth-tier. See the futures hub.

Check API Account Details, Plan, and Usage Quota

Returns account details, plan, and usage quota.

GET /v1/account

Authentication: Required (X-Api-Key header or apiKey query parameter)

Rate Limited: Yes

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://lab.flashalpha.com/v1/account

import requests

resp = requests.get(
    "https://lab.flashalpha.com/v1/account",
    headers={"X-Api-Key": "YOUR_API_KEY"}
)
acct = resp.json()
print(f"Plan: {acct['plan']} | Limit: {acct['daily_limit']}/day")

const resp = await fetch(
  "https://lab.flashalpha.com/v1/account",
  { headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
const acct = await resp.json();
console.log(`Plan: ${acct.plan} | Limit: ${acct.daily_limit}/day`);

API Key

Example response:

{
  "user_id": "...",
  "email": "...",
  "plan": "growth",
  "daily_limit": "2500",
  "billing_cycle_end": "2026-03-01"
}

Response fields:

Field	Type	Description
`user_id`	string	Unique user identifier
`email`	string	Account email
`plan`	string	Current plan (free, basic, growth, pro, enterprise)
`daily_limit`	string	Daily request limit
`billing_cycle_end`	string	End of current billing cycle

List All Tracked Options Symbols

Returns tracked symbols list.

GET /v1/symbols

Authentication: Required (X-Api-Key header or apiKey query parameter)

Rate Limited: Yes

curl -H "X-Api-Key: YOUR_API_KEY" \
  https://lab.flashalpha.com/v1/symbols

import requests

resp = requests.get(
    "https://lab.flashalpha.com/v1/symbols",
    headers={"X-Api-Key": "YOUR_API_KEY"}
)
data = resp.json()
print(f"Tracking {data['count']} symbols: {', '.join(data['symbols'])}")

const resp = await fetch(
  "https://lab.flashalpha.com/v1/symbols",
  { headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
const data = await resp.json();
console.log(`Tracking ${data.count} symbols: ${data.symbols.join(", ")}`);

API Key

Example response:

{
  "symbols": ["SPY", "QQQ"],
  "count": 2,
  "update_frequency": "live",
  "last_updated": "2026-02-28T16:30:45Z"
}

API Health Check and Service Status

Health check endpoint. No authentication required. Not rate limited.

GET /health

Authentication: Not required

Rate Limited: No

curl https://lab.flashalpha.com/health

import requests

resp = requests.get("https://lab.flashalpha.com/health")
health = resp.json()
print(f"Status: {health['status']} ({health['duration']}ms)")
for check in health["checks"]:
    print(f"  {check['name']}: {check['status']}")

const resp = await fetch("https://lab.flashalpha.com/health");
const health = await resp.json();
console.log(`Status: ${health.status} (${health.duration}ms)`);
health.checks.forEach(c => console.log(`  ${c.name}: ${c.status}`));

API Key (not needed for health)

Example response:

{
  "status": "Healthy",
  "duration": 12.45,
  "checks": [
    { "name": "market_feed", "status": "Healthy", "duration": 8.2 },
    { "name": "market_data", "status": "Healthy", "duration": 3.5 }
  ]
}

Note: This endpoint does not require authentication and is not rate limited. Use it for monitoring and uptime checks.

Options Data Field Glossary and Definitions

Comprehensive reference of all fields returned across the API.

Field	Type	Description
`gamma_flip`	number	Strike price where net GEX crosses zero - see gamma flip. Above this level, dealers are long gamma (mean-reverting, dampened moves). Below, dealers are short gamma (trending, amplified moves). The most important single level for intraday traders.
`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 `undetermined` (near zero, transitional). Use to set strategy bias: sell premium in positive, trade momentum in negative.
`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 `"REQUIRES_ALPHA_TIER"` on lower plans.

α Why SVI-smoothed IV?

Raw BSM IV can be noisy or undefined for deep OTM strikes and illiquid contracts. svi_vol uses Gatheral's parametric fit across the entire surface to produce stable, arbitrage-free IV - ideal for pricing engines, vol surface construction, and Greeks computation.

Upgrade to Alpha →

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

Master table of every endpoint in the FlashAlpha Lab API.

Method	Path	Auth	Description
`GET`	`/stockquote/{ticker}`	Yes	Live stock quote
`GET`	`/optionquote/{ticker}`	Yes	Option quotes with greeks
`GET`	`/v1/exposure/gex/{symbol}`	Yes	Gamma exposure by strike
`GET`	`/v1/exposure/dex/{symbol}`	Yes	Delta exposure by strike
`GET`	`/v1/exposure/vex/{symbol}`	Yes	Vanna exposure by strike
`GET`	`/v1/exposure/chex/{symbol}`	Yes	Charm exposure by strike
`GET`	`/v1/exposure/summary/{symbol}`	Yes	Full exposure summary
`GET`	`/v1/exposure/levels/{symbol}`	Yes	Key support/resistance levels
`GET`	`/v1/exposure/narrative/{symbol}`	Yes	Verbal narrative analysis
`GET`	`/v1/exposure/zero-dte/{symbol}`	Yes	0DTE analytics: pin risk, expected move, gamma acceleration
`GET`	`/v1/maxpain/{symbol}`	Yes	Max pain strike, pain curve, pin probability (Basic+)
`GET`	`/v1/exposure/sheet/{symbol}`	Yes	Unified per-strike GEX/DEX/VEX/CHEX/DAG sheet + LIS + peaks (Growth+)
`GET`	`/v1/exposure/term-structure/{symbol}`	Yes	Per-greek exposure by DTE bucket and per expiry (Growth+)
`GET`	`/v1/exposure/oi-diff/{symbol}`	Yes	Day-over-day open-interest deltas, top changes (Growth+)
`GET`	`/v1/exposure/basket`	Yes	Weighted cross-symbol GEX/DEX/VEX/CHEX aggregate (Growth+)
`GET`	`/v1/volatility/{symbol}`	Yes	Realized vol, IV-RV spreads, skew, term structure
`GET`	`/v1/volatility/skew-term/{symbol}`	Yes	Skew term structure: 25d/10d wings, risk reversal, butterfly (Growth+)
`GET`	`/v1/volatility/spot-vol-correlation/{symbol}`	Yes	20d/60d spot-vol correlation (Growth+)
`GET`	`/v1/volatility/realized/{symbol}`	Yes	Realized (historical) volatility series, multiple windows (Alpha)
`GET`	`/v1/volatility/forecast/{symbol}`	Yes	Forward volatility regime forecast (Alpha)
`GET`	`/v1/liquidity/{symbol}`	Yes	Per-expiry + chain liquidity scores, spreads, OI depth (Growth+)
`GET`	`/v1/expected-move/{symbol}`	Yes	Straddle-implied expected move per expiry (Basic+)
`GET`	`/v1/adv_volatility/{symbol}`	Yes	SVI parameters, variance surface, arbitrage detection (Alpha)
`GET`	`/v1/surface/svi/{symbol}`	Yes	Live SVI parameters per expiry (Alpha)
`GET`	`/v1/dispersion`	Yes	Implied vs realized correlation across an index basket (Alpha)
`GET`	`/v1/macro/vix-state`	Yes	VIX vs SPX-realized regime classifier (Growth+)
`GET`	`/v1/vrp/{symbol}`	Yes	VRP dashboard: z-score, directional VRP, strategy scores (Alpha)
`GET`	`/v1/vrp/{symbol}/history`	Yes	Daily VRP time series for charting/backtesting (Alpha)
Flow Analytics (simulation-aware, supports `?expiry=YYYY-MM-DD`)
`GET`	`/v1/flow/levels/{symbol}`	Yes	Live gamma flip + call/put walls + max pain on effective OI (Growth+)
`GET`	`/v1/flow/pin-risk/{symbol}`	Yes	Live pin score (weighted 30% OI + 25% proximity + 25% time + 20% gamma) (Growth+)
`GET`	`/v1/flow/summary/{symbol}`	Yes	Headline flow direction, intraday OI delta, live GEX, % shift (Growth+)
`GET`	`/v1/flow/gex/{symbol}`	Yes	Live net GEX + per-strike profile on effective OI (Growth+)
`GET`	`/v1/flow/dex/{symbol}`	Yes	Live net DEX + per-strike profile on effective OI (Growth+)
`GET`	`/v1/flow/dealer-risk/{symbol}`	Yes	Settled vs live dealer GEX/DEX delta with direction classifier (Growth+)
`GET`	`/v1/flow/oi/{symbol}`	Yes	Raw OI simulator state: official, simulated, effective, intraday delta, confidence (Alpha+)
`GET`	`/v1/flow/live/{symbol}`	Yes	Headline flow bundle in one call (Alpha+)
`GET`	`/v1/flow/signals/{symbol}`	Yes	Scored, classified unusual-flow feed: sweep/block, NBBO aggressor, opening bias, intent, 0-100 score with breakdown (Alpha+)
`GET`	`/v1/flow/signals/{symbol}/summary`	Yes	Net bullish/bearish + opening/closing premium roll-up + top 10 signals (Alpha+)
`GET`	`/v1/flow/options/{symbol}/dealer-premium`	Yes	Full-tape Net Dealer Premium roll-up over a window (Alpha+)
Zero-DTE Flow (intraday, effective OI)
`GET`	`/v1/flow/zero-dte/snapshot/{symbol}`	Yes	Live 0DTE shape + flow_direction block (Growth+)
`GET`	`/v1/flow/zero-dte/series/{symbol}`	Yes	Intraday 0DTE flow time series (Growth+)
`GET`	`/v1/flow/zero-dte/hedge-flow/{symbol}`	Yes	Dealer hedge-flow time series, per-bar + cumulative (Growth+)
`GET`	`/v1/flow/zero-dte/heatmap/{symbol}`	Yes	Per-strike value matrix (strike x time) (Alpha+)
`GET`	`/v1/flow/zero-dte/strike-flow/{symbol}`	Yes	Per-strike signed aggressor flow per bar (Alpha+)
Raw Flow Data (trade tape proxy, camelCase, Alpha+)
`GET`	`/v1/flow/options/{symbol}/recent`	Yes	Recent option trades by underlying, newest first (Alpha+)
`GET`	`/v1/flow/options/{symbol}/summary`	Yes	Buy/sell/mid/net contract volume totals by underlying (Alpha+)
`GET`	`/v1/flow/options/{symbol}/blocks`	Yes	Large option trades filtered by min contract size (Alpha+)
`GET`	`/v1/flow/options/{symbol}/history`	Yes	Minute option-flow buckets with VWAP, high/low (Alpha+)
`GET`	`/v1/flow/options/{symbol}/cumulative`	Yes	Running cumulative net option flow (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/recent`	Yes	Recent stock trades by symbol (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/summary`	Yes	Stock buy/sell/mid/net share volume totals (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/blocks`	Yes	Large stock trades (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/history`	Yes	Minute stock-flow buckets with VWAP, OHLC (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/cumulative`	Yes	Running cumulative net stock flow (Alpha+)
`GET`	`/v1/flow/stocks/{symbol}/bars`	Yes	Multi-resolution OHLCV + flow bars from the live tape (Alpha+)
`GET`	`/v1/flow/options/leaderboard`	Yes	Cross-symbol option-flow buyers/sellers by net notional (cached 30s) (Alpha+)
`GET`	`/v1/flow/options/outliers`	Yes	Cross-symbol option-flow outliers with imbalance, skew (Alpha+)
`GET`	`/v1/flow/stocks/leaderboard`	Yes	Cross-symbol stock-flow leaderboard (Alpha+)
`GET`	`/v1/flow/stocks/outliers`	Yes	Cross-symbol stock-flow outliers (Alpha+)
Strategy Signals (decision envelope)
`GET`	`/v1/strategies/flow-anomaly/{symbol}`	Yes	Directional options-flow imbalance signal (Growth+)
`GET`	`/v1/strategies/expiry-positioning/{symbol}`	Yes	OPEX pin-risk / iron-fly setup (Basic+)
`GET`	`/v1/strategies/zero-dte/{symbol}`	Yes	Same-day range-compression read (Growth+, 0DTE)
`GET`	`/v1/strategies/dealer-regime/{symbol}`	Yes	Dealer gamma regime classifier (Growth+)
`GET`	`/v1/strategies/vol-carry/{symbol}`	Yes	VRP carry credit-spread selection (Alpha+)
`GET`	`/v1/strategies/yield-enhancement/{symbol}`	Yes	Covered-call / cash-secured-put overlay (Growth+)
`GET`	`/v1/strategies/surface-anomaly/{symbol}`	Yes	SVI residual rich/cheap wing detection (Alpha+)
`GET`	`/v1/strategies/skew/{symbol}`	Yes	25-delta skew / risk-reversal signal (Growth+)
`GET`	`/v1/strategies/term-structure/{symbol}`	Yes	ATM-IV term-structure signal (Growth+)
`GET`	`/v1/strategies/tail-pricing/{symbol}`	Yes	Downside-tail richness signal (Growth+)
Earnings
`GET`	`/v1/earnings/calendar`	Yes	Upcoming earnings calendar (Growth+)
`GET`	`/v1/earnings/expected-move/{symbol}`	Yes	Earnings-implied move decomposition (Growth+)
`GET`	`/v1/earnings/history/{symbol}`	Yes	Past surprises, moves, IV crush (Growth+)
`GET`	`/v1/earnings/iv-crush/{symbol}`	Yes	Expected + historical IV-crush distribution (Growth+)
`GET`	`/v1/earnings/vrp/{symbol}`	Yes	Earnings vol-risk-premium (implied vs realized) (Alpha+)
`GET`	`/v1/earnings/dealer-positioning/{symbol}`	Yes	Event-scoped dealer exposure (Alpha+)
`GET`	`/v1/earnings/strategies/{symbol}`	Yes	Earnings strategy-suitability scores (Alpha+)
`GET`	`/v1/earnings/screener`	Yes	Cross-sectional earnings screener (Alpha+)
Structures (pure-math, no market lookup)
`POST`	`/v1/structures/pnl`	Yes	At-expiry P&L curve + breakevens (Basic+)
`POST`	`/v1/structures/greeks`	Yes	Aggregate position greeks (Basic+)
Screener & Pricing
`POST`	`/v1/screener`	Yes	Real-time multi-factor options screener across ~250 symbols (docs)
`GET`	`/v1/screener/fields`	Yes	List queryable screener fields + types (Free+)
`GET`	`/v1/pricing/greeks`	Yes	Full BSM greeks (delta through ultima)
`GET`	`/v1/pricing/iv`	Yes	Implied volatility solver (Newton-Raphson)
`GET`	`/v1/pricing/kelly`	Yes	Kelly criterion position sizing (Growth+)
`GET`	`/v1/stock/{symbol}/summary`	Public/Yes	Stock summary (cached public / live authenticated)
`GET`	`/v1/surface/{symbol}`	No	Vol surface grid
`GET`	`/v1/options/{ticker}`	Yes	Option chain metadata
`GET`	`/v1/tickers`	Yes	All available ticker symbols
`GET`	`/v1/account`	Yes	Account info & usage
`GET`	`/v1/symbols`	Yes	Tracked symbols
`GET`	`/v1/universe`	No	Curated tier-1/tier-2 pre-warmed symbol directory
`GET`	`/health`	No	Health check

HTTP Status Codes and Error Response Reference

Status	Description
`200`	Success
`400`	Bad request - invalid parameters
`401`	Unauthorized - invalid or missing API key
`404`	Not found - symbol not tracked or no data
`429`	Rate limited - daily quota exceeded
`500`	Internal server error
`503`	Service unavailable - upstream service temporarily unavailable

FlashAlpha Lab API Reference: Endpoints, Fields, and Status Codes

Check API Account Details, Plan, and Usage Quota

List All Tracked Options Symbols

API Health Check and Service Status

Options Data Field Glossary and Definitions

Complete REST API Endpoint Index

HTTP Status Codes and Error Response Reference

Ready to build?