- Live API Reference
- Reference Essentials
- FlashAlpha API Reference
FlashAlpha API Reference
Every FlashAlpha Lab API endpoint in one place: market data, dealer exposure, live flow, volatility, pricing calculators, earnings, strategy signals and the screener, with plan tiers and links to full docs.
Quick Start
1. Get your API key from the pricing page. The Free plan is enough for the call below.
2. Make your first call:
curl -H "X-Api-Key: YOUR_API_KEY" https://lab.flashalpha.com/v1/exposure/levels/AAPL3. Explore the response - you'll get AAPL's key dealer levels: gamma flip, call wall, put wall, highest-OI strike and 0DTE magnet.
Free covers single stocks in the ~250-symbol tracked universe (/v1/universe). ETF and index symbols (SPY, QQQ, SPX, VIX...) need Basic+, and GEX across the full chain (no expiration filter) needs Growth+.
Every US equity and ETF symbol is supported. Free data is delayed.
Authentication
All endpoints (except /health, /v1/surface, /v1/universe, and unauthenticated /v1/stock/{symbol}/summary) require an API key. Pass it in the X-Api-Key header:
curl -H "X-Api-Key: YOUR_API_KEY" https://lab.flashalpha.com/v1/symbolsOr as a query parameter:
https://lab.flashalpha.com/v1/symbols?apiKey=YOUR_API_KEYEndpoints
Market Data (4)
Live stock and option quotes, the SVI-fitted volatility surface and a one-call stock summary. The surface and the summary also work without an API key.
/stockquote/{ticker}
Free+
Live bid, ask, mid and last price for a stock or ETF
Stock Quote docs →/optionquote/{ticker}
Growth+
Option quotes with BSM greeks, implied volatility, open interest and volume
Option Quotes & Chains docs →/v1/surface/{symbol}
Public
SVI-fitted implied volatility grid by tenor and moneyness
Volatility Surface Grid docs →/v1/stock/{symbol}/summary
Public
Price, volatility, options flow, dealer exposure and macro context in one callPublic (previous session) / Free+ (live)
Exposure Analytics (15)
Dealer gamma, delta, vanna and charm exposure computed on official open interest: per-strike profiles, key levels, max pain, term structure, baskets and plain-English summaries.
/v1/exposure/summary/{symbol}
Growth+
Net GEX, DEX, VEX and CHEX with regime, interpretations and hedging estimates
Exposure Summary docs →/v1/exposure/gex/{symbol}
Free+
Gamma exposure by strike, with the gamma flip and hedging pressure zonesFree+ (single expiry, equities) / Basic+ (ETFs & indexes) / Growth+ (full chain)
/v1/exposure/dex/{symbol}
Basic+
Net delta exposure by strike and the dealer hedging bias
Delta Exposure - DEX docs →/v1/exposure/vex/{symbol}
Basic+
Vanna exposure by strike: how dealer delta shifts when implied volatility moves
Vanna Exposure - VEX docs →/v1/exposure/chex/{symbol}
Basic+
Charm exposure by strike: how dealer delta changes as time passes
Charm Exposure - CHEX docs →/v1/exposure/levels/{symbol}
Free+
Gamma flip, call wall, put wall, highest-OI strike and 0DTE magnetFree+ (equities) / Basic+ (ETFs & indexes)
/v1/exposure/narrative/{symbol}
Growth+
Plain-English briefing on regime, key levels, flow, vanna, charm and outlook
Exposure Narrative docs →/v1/exposure/zero-dte/{symbol}
Growth+
Same-day expiry analytics: gamma regime, expected move, pin risk and hedging
0DTE Exposure docs →/v1/maxpain/{symbol}
Basic+
Max pain strike, pain curve, dealer alignment and pin probability for each expiry
Max Pain docs →/v1/exposure/sheet/{symbol}
Growth+
Per-strike GEX, DEX, VEX, CHEX and DAG in one table, plus gamma peaks and the inflection strike
Exposure Sheet docs →/v1/exposure/term-structure/{symbol}
Growth+
GEX, DEX, VEX and CHEX bucketed by DTE and per expiry, plus SPY/QQQ gamma concentration
Exposure Term Structure docs →/v1/exposure/expiry-impact/{symbol}
Growth+
SPY/QQQ gamma concentration with one expiry excluded: share removed, net GEX change and strikes hit
Expiry Impact API docs →/v1/exposure/strike-dependency/{symbol}
Growth+
One exact SPY/QQQ strike's gross and net gamma split across its expiries
Strike Dependency API docs →/v1/exposure/oi-diff/{symbol}
Growth+
Day-over-day open interest change per contract, with the largest moves and call/put totals
Open Interest Changes docs →/v1/exposure/basket
Growth+
Weighted GEX, DEX, VEX and CHEX across up to 50 symbols, with per-symbol contributions
Exposure Basket docs →
Simulation-Aware Flow Analytics (13)
The intraday OI simulator updates open interest from live trades, so levels, pin risk and GEX/DEX follow today's flow instead of the morning baseline. Also covers unusual-flow signals and Trade Flow Data, the options and stock trade tape.
/v1/flow/summary/{symbol}
Growth+
Intraday flow direction against the morning OI baseline, with live GEX and percent shift
Flow Summary docs →/v1/flow/levels/{symbol}
Growth+
Gamma flip, call wall, put wall and max pain recomputed on live intraday OI
Flow Levels docs →/v1/flow/pin-risk/{symbol}
Growth+
Live 0-100 pin-risk score for the nearest expiry, with the magnet strike and sub-scores
Pin Risk docs →/v1/flow/gex/{symbol}
Growth+
Live gamma exposure total, gamma flip and per-strike profile on effective OI
Flow GEX docs →/v1/flow/dex/{symbol}
Growth+
Live delta exposure total and per-strike profile on effective OI
Flow DEX docs →/v1/flow/dealer-risk/{symbol}
Growth+
Settled versus live dealer GEX and DEX, with percent shift and a direction label
Dealer Risk docs →/v1/flow/options/{symbol}/dealer-premium
Alpha+
Net dealer premium over a time window, rolled up from the full customer-flow tape
Dealer Premium docs →/v1/flow/oi/{symbol}
Alpha+
OI simulator state per contract: official, simulated and effective open interest
Open Interest Simulator docs →/v1/flow/live/{symbol}
Alpha+
Simulator state, live levels, pin risk and live GEX/DEX totals in a single call
Live Bundle docs →/v1/flow/signals/{symbol}
Alpha+
Scored unusual-flow feed: sweep or block, aggressor side, opening bias and directional intent
Flow Signals docs →/v1/flow/signals/{symbol}/summary
Alpha+
Net bullish and bearish premium plus the top signals, cheap to call across a watchlist
Flow Signals Summary docs →/v1/flow/zero-dte/{view}/{symbol}
Growth+
Live 0DTE views on effective OI: snapshot, series, hedge flow, heatmap and strike flowGrowth+ (snapshot, series, hedge flow) / Alpha+ (heatmap, strike flow)
/v1/flow/options|stocks/{symbol}/…
Alpha+
Trade Flow Data, the options and stock trade tape: recent, summary, blocks, history, per-contract minute history, cumulative, bars, leaderboards and outliers
Overview docs →
Pricing & Sizing (3)
Calculators that run on your own inputs rather than market data: BSM greeks, implied volatility from an option price, and Kelly position sizing.
/v1/pricing/greeks
Free+
Full BSM greeks (first, second and third order) from your own inputs
BSM Greeks Calculator docs →/v1/pricing/iv
Free+
Implied volatility from an option's market price
Implied Volatility Solver docs →/v1/pricing/kelly
Growth+
Kelly-optimal position size for an option trade
Kelly Position Sizing docs →
Volatility Analytics (12)
Realized and implied volatility, skew and term structure, volatility forecasts, liquidity, dispersion, SVI calibration and the volatility risk premium (VRP).
/v1/volatility/{symbol}
Growth+
Realized vol, IV-RV spreads, skew, term structure and hedging scenarios
Volatility Analysis docs →/v1/expected-move/{symbol}
Basic+
Straddle-implied expected move and price range for each upcoming expiry
Expected Move by Expiry docs →/v1/volatility/skew-term/{symbol}
Growth+
Per-expiry ATM and wing IVs with 25-delta skew, risk reversal and butterfly
Skew & Volatility Term Structure docs →/v1/volatility/spot-vol-correlation/{symbol}
Growth+
20-day and 60-day correlation between spot returns and ATM implied vol, with a regime label
Spot-Volatility Correlation docs →/v1/volatility/realized/{symbol}
Alpha+
Parkinson, Garman-Klass, Rogers-Satchell, Yang-Zhang and close-to-close realized vol over 10, 20 and 30 days
Realized Volatility docs →/v1/volatility/forecast/{symbol}
Alpha+
EWMA, HAR-RV and GARCH(1,1) volatility forecasts from daily price history
Volatility Forecast docs →/v1/liquidity/{symbol}
Growth+
Execution score, bid-ask spreads and OI depth for each expiry and the whole chain
Liquidity docs →/v1/dispersion
Alpha+
Implied and realized correlation between an index and your constituent basket, with the correlation premium
Dispersion docs →/v1/surface/svi/{symbol}
Alpha+
Calibrated SVI parameters for each expiry slice, with ATM total variance and ATM IV
SVI Parameters docs →/v1/adv_volatility/{symbol}
Alpha+
Advanced volatility: SVI params, variance surface, arb detection, greeks surfaces, var swap
Advanced Volatility docs →/v1/vrp/{symbol}
Alpha+
Volatility risk premium dashboard: spreads, z-score, directional VRP, regime, strategy scores and dealer risk
VRP Analytics docs →/v1/vrp/{symbol}/history
Alpha+
Daily VRP time series for charting and backtesting, updated after each close
VRP History docs →
Strategy Signals (11)
Each endpoint scores one setup, such as a flow anomaly, an OPEX pin, a 0DTE range or the dealer regime, and proposes a matching trade. Skew, term structure and tail pricing return the signal only.
Every signal returns the same strategy decision envelope: a 0-100 score, a regime and ranked structure candidates.
/v1/strategies/flow-anomaly/{symbol}
Growth+
Scores one-sided call or put flow and proposes the matching short vertical spread
Flow Anomaly docs →/v1/strategies/expiry-positioning/{symbol}
Basic+
Scores OPEX pin risk from max pain, OI and dealer levels, and proposes an iron fly
Expiry Positioning docs →/v1/strategies/zero-dte/{symbol}
Growth+
Same-day range-compression read with time-of-day context, proposing an iron fly on strong pinsGrowth+ with 0DTE access
/v1/strategies/dealer-regime/{symbol}
Growth+
Classifies the dealer gamma regime and proposes an iron condor when it is compressive
Dealer Regime 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.
sell-window docs →/v1/strategies/yield-enhancement/{symbol}
Growth+
Finds the best covered call or cash-secured put at a target delta
Yield Enhancement docs →/v1/strategies/vol-carry/{symbol}
Alpha+
Scores implied vol richness against realized vol and proposes short put spreads or condors
Volatility Carry docs →/v1/strategies/surface-anomaly/{symbol}
Alpha+
Finds rich or cheap wings against the SVI fit and proposes a credit vertical on a rich wing
Surface Anomaly docs →/v1/strategies/skew/{symbol}
Growth+
Signal only: 25-delta skew and risk reversal for one expiry, with the dominant wing
Skew Signal docs →/v1/strategies/term-structure/{symbol}
Growth+
Signal only: ATM implied-vol term structure, contango or backwardation, and slope
Term Structure Signal docs →/v1/strategies/tail-pricing/{symbol}
Growth+
Signal only: 10-delta put IV against ATM and whether the crash tail is rich or cheap
Tail Pricing docs →
Earnings & Events (8)
The earnings calendar, implied versus realized moves, IV crush, event VRP, dealer positioning around the event and suitability scores for common earnings structures.
/v1/earnings/calendar
Growth+
Upcoming earnings dates over a forward window, filterable by symbol and importance
Earnings Calendar docs →/v1/earnings/expected-move/{symbol}
Growth+
The next event's implied move, split into the earnings jump and normal drift
Earnings Expected Move docs →/v1/earnings/history/{symbol}
Growth+
Past earnings with EPS and revenue surprises, implied versus actual moves and IV crush
Earnings History docs →/v1/earnings/iv-crush/{symbol}
Growth+
Expected IV crush for the next event and the symbol's historical crush distribution
IV Crush docs →/v1/earnings/vrp/{symbol}
Alpha+
Event-implied move against the symbol's realized earnings moves, with a richness assessment
Earnings VRP docs →/v1/earnings/dealer-positioning/{symbol}
Alpha+
Gamma flip, walls and net GEX around the earnings event, with charm into the event
Earnings Dealer Positioning docs →/v1/earnings/strategies/{symbol}
Alpha+
0-100 suitability scores for common earnings structures such as straddles and iron condors
Earnings Strategy Signals docs →/v1/earnings/screener
Alpha+
Upcoming earnings ranked by VRP richness, cheapest implied move, historical crush or importance
Earnings Screener docs →
Structures & Screener (3)
Greeks and at-expiry P&L for multi-leg positions you define, plus the live screener that filters and ranks the universe.
/v1/structures/greeks
Basic+
Aggregate Black-Scholes greeks across a multi-leg position, with per-leg expiry and IV
Position Greeks docs →/v1/structures/pnl
Basic+
At-expiry P&L curve, breakevens and max profit or loss for a multi-leg structure
Position P&L Curve docs →/v1/screener
Growth+
Filter and rank the live universe on stock, expiry, strike and contract metrics (see fields & cookbook)
Screener API docs →
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/options/{ticker}
Free+
Expirations and strikes for a symbol's option chain
Option Expiries & Strikes docs →/v1/symbols
Free+
Symbols that have been queried and have live data loaded
Queried Symbols docs →/v1/universe
Public
Curated tier-1 and tier-2 symbols that stay pre-warmed, with 0DTE availability flags
Symbol Universe docs →/v1/macro/vix-state
Growth+
Spot VIX against SPX 20-day realized vol, labelled overvixing, undervixing or neutral
VIX State docs →/v1/account
Free+
Your plan, daily limit, usage today and quota reset time
Account, Plan & Usage docs →Historical Replay
Point-in-time replay lives on a dedicated host, https://historical.flashalpha.com, and needs an Alpha plan API key. 52 analytics routes are mirrored there, including historical stock and option quotes, GEX/DEX/VEX/CHEX, max pain, VRP, exposure summary, advanced volatility, stock summary and the full flow suite (Trade Flow Data, flow analytics and the intraday OI simulator). Everything else is live-only, for example earnings, screener, structures, alerts and the pricing calculators. Every request takes a point-in-time ?at=yyyy-MM-ddTHH:mm:ss parameter (ET wall-clock - no trailing Z, do not shift by UTC offset). A date-only ?at=yyyy-MM-dd resolves to 15:55 ET on the exposure routes (/v1/exposure/*), dispersion and expected move, so same-day contracts keep live greeks, and to 16:00 ET (the close) on every other route.
curl -H "X-Api-Key: YOUR_ALPHA_KEY" \
"https://historical.flashalpha.com/v1/exposure/gex/SPY?at=2024-08-05T10:30:00"
Replay Setup (2)
Start here: authentication, point-in-time timestamps and which tickers and dates have historical coverage.
Auth, ?at= point-in-time semantics and the replay model
Every ticker with historical coverage, with date ranges and data-quality counts
Coverage & Supported Symbols docs →
Market Data (1)
The one-call stock summary as it stood at any minute in the replay window.
/v1/stock/{symbol}/summary
Alpha+
Price, volatility, options flow, exposure and macro context at any minute
Stock Summary docs →
Exposure Analytics (2)
Dealer gamma exposure and max pain replayed at any minute, in the same shape as the live endpoints.
/v1/exposure/gex/{symbol}
Alpha+
Gamma exposure by strike at any minute, same shape as live GEX
Gamma Exposure - GEX docs →/v1/maxpain/{symbol}
Alpha+
Max pain, pain curve, dealer alignment and pin probability at any minute
Max Pain docs →
Volatility Analytics (1)
The volatility risk premium, with percentile and z-score references bounded to the replay date.
/v1/vrp/{symbol}
Alpha+
Volatility risk premium with date-bounded percentile and z-score references
VRP Analytics docs →Historical API
Point-in-time replay lives on the dedicated historical host, https://historical.flashalpha.com. 52 analytics routes are mirrored there with a required ?at= parameter and are available on Alpha; earnings, screener, structures, alerts and the pricing calculators are live-only.
Rate Limits & Plans
Every authenticated response includes rate limit headers:
| Header | Description |
|---|---|
X-RateLimit-Limit | Max requests per day (or unlimited) |
X-RateLimit-Remaining | Requests remaining today |
X-RateLimit-Reset | Unix timestamp when quota resets |
Retry-After | Seconds to wait (only on 429) |
| Plan | Daily Requests | Access |
|---|---|---|
| Free | 5 | Stock quotes, GEX & key levels (single expiry), BSM greeks, IV solver, tickers, options meta, symbols, surface, stock summary (delayed without a key, live with one; CME futures delayed below Growth) - individual US equities only. Live host only. |
| Basic | 250 | Everything in Free + ETFs & index symbols (SPY, QQQ, SPX, VIX...) + DEX/VEX/CHEX exposure + max pain + Market Overview page. Live host only. |
| Growth | 2,500 | + Exposure summary, narrative, 0DTE analytics, volatility analytics, earnings (calendar, expected move, history, IV crush), option quotes, full-chain GEX (no expiry filter), Kelly sizing, flow analytics (/v1/flow/levels, /pin-risk, /summary, /gex, /dex, /dealer-risk). Live host only. |
| Alpha | Unlimited | + Advanced volatility (SVI parameters, variance surfaces, arbitrage detection, greeks surfaces, variance swap pricing), VRP analytics (risk premium, z-score, percentile, directional VRP, term structure, GEX/vanna-conditioned regime, strategy scores, dealer flow risk, macro context), SVI-smoothed IV on option quotes, raw OI simulator state (/v1/flow/oi), flow bundle (/v1/flow/live), unusual-flow signals (/v1/flow/signals) and raw option/stock flow data (/v1/flow/options/*, /v1/flow/stocks/*). Adds full historical replay on historical.flashalpha.com with point-in-time ?at= on 52 analytics routes - earnings, screener and structures are live-only (shares the daily request bucket). |
| Enterprise | Unlimited | Everything in Alpha + the Enterprise snapshot trigger. |
Streaming (Commercial)
Real-time WebSocket streaming of 500+ computed metrics is available as a commercial bundle (from $4,500/mo, contact us), separate from the REST plans above. The bundle includes a dedicated node, streaming compute, and 500 concurrent subscriptions; additional capacity is added in blocks of 500 subscriptions at $1,500/mo per block. The endpoint is provisioned per client during onboarding.
- Protocol: one WebSocket, JSON text frames, snake_case fields. Subscribe with
{"action":"subscribe","symbol":"SPY","metric":"exposure.gex.net_gex","cadence_ms":1000}; the server acks with asub_id, then pushesupdateframes (seq,tsin epoch ms UTC, numericvalue) each time the metric recomputes. Errors arrive as frames and do not close the connection. - Metric ids are dotted
endpoint.method.field(e.g.exposure.gex.net_gex,flow.dealer_risk.live_net_gex) and map one-to-one to fields of the REST endpoints listed under Endpoints; the live catalog is discovered at runtime. - Cadence:
cadence_msaccepts0(continuous) or a target interval of100-60000ms; cadence is a target, not a latency SLA. Delivery coalesces latest-wins per subscription. - Endpoint:
wss://stream.flashalpha.com/ws. - Auth: the standard
X-Api-Keyheader on the WebSocket handshake, validated before the upgrade.
How streaming works - commercial contact.
Error Responses
Error responses carry a JSON body with an error code and a message, in one of the shapes below. The exception is 401, which has no body, so check the status code before parsing JSON.
| Shape | When | Content-Type |
|---|---|---|
| Empty (0 bytes) | 401 (missing or invalid key, except the Risk Engine), 405 (method not allowed), 404 for a route that does not exist | none |
| RFC 7807 problem details | A query value of the wrong type, a required value the framework checks (for example historical at), or a POST body that cannot be parsed. Also the 404 of an Alerts id that does not exist | application/problem+json |
{error, message} | Most endpoint errors: 400, 404, 422, 503 | application/json |
{status: "ERROR", ...} | 403, 429, the Risk Engine, and validation_error from the Screener and Alerts | application/json |
401 Unauthorized
A request with a missing or invalid API key gets 401 Unauthorized with an empty body (no Content-Type). Check the X-Api-Key header or the apiKey query parameter. The Risk Engine returns missing_api_key or invalid_api_key in a JSON body instead.
403 Tier Restricted
{
"status": "ERROR", "endpoint_version": "2026.09.30", "error": "tier_restricted",
"message": "This endpoint requires the Growth plan or higher.",
"current_plan": "Basic", "required_plan": "Growth"
}On the Free plan, a stock outside the ~250-symbol tracked universe (/v1/universe) gets 403 with symbol_not_in_free_universe on /v1/exposure/gex, /v1/exposure/levels and /stockquote; the body has current_plan Free and required_plan Basic. Basic and higher can query any US-listed symbol.
429 Too Many Requests
{
"status": "ERROR", "endpoint_version": "2026.09.30", "error": "Quota exceeded",
"message": "You have exceeded your daily API quota of 5 requests on the Free plan. Please upgrade to Basic for a higher limit. Your quota resets at 2026-10-29 00:00:00 UTC.",
"current_plan": "Free", "limit": 5,
"upgrade_to": "Basic", "reset_at": "2026-10-29T00:00:00.0000000Z"
}A 429 carries Retry-After (seconds until the quota resets at 00:00 UTC), X-RateLimit-Limit, X-RateLimit-Remaining: 0 and X-RateLimit-Reset (Unix time in seconds). limit is your plan's daily quota. Requests rejected with 403 still count toward the daily quota.
Other status codes
| Status | Meaning |
|---|---|
400 | A parameter is missing or invalid (for example invalid_input, invalid_resolution). A value of the wrong type returns an RFC 7807 problem-details body |
404 | No data for the symbol (for example symbol_not_found, no_data). Some routes use their own code: no_option_data, no_coverage, no_snapshot, index_not_found, insufficient_history, expiry_not_found, research_pack_not_available, research_artifact_not_found, No option quote found. |
405 | The route does not accept this HTTP method (empty body) |
422 | The value cannot be computed, for example an option price outside the arbitrage-free range (iv_not_found), or the symbol is not supported by that operation (unsupported_symbol) |
503 | Data is still loading, a source is disabled (historical_source_unhealthy), or /health reports a failing dependency |
504 | Gateway timeout on a slow request: HTML body, Retry-After: 120. Retry later |
Full list: HTTP Status Codes.
Conventions
- All timestamps are UTC in ISO 8601 format
- All exposure values are in USD notional
- Dates use
yyyy-MM-ddformat - GEX formula:
gamma * OI * 100 * spot² * 0.01(per 1% move, SpotGamma convention) - Greeks are calculated via Black-Scholes-Merton (not sourced from vendor)
- Implied volatility is derived from Black-Scholes-Merton inversion. The
svi_volfield (SVI-smoothed IV) requires the Alpha plan - on lower plans it isnullandsvi_vol_gatedis"requires_alpha_tier". - Dealer position is the opposite of net exposure (dealers are counterparty)
- OI changes are day-over-day deltas (when prior-day snapshot is available)
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