Downloads - API Spec & Sample Responses

Downloads for AI agents & integration

Full API spec in Markdown plus a real response from every endpoint. Feed the spec to your LLM, wire the JSON samples into mocks or tests.

Download everything (.zip) api.md historical.md risk-engine.md historical.openapi.json

Backtesting? Pair these with the Historical API bundle: historical-gex.json, historical-vrp.json, etc., or the OpenAPI at historical.openapi.json.

Individual endpoint samples (70 files)

stockquote.json 162 B optionquote.json 386 KB tickers.json 154 KB symbols.json 154 KB options.json 78 KB stock-summary.json 7 KB surface.json 45 KB surface-svi.json 6 KB account.json 237 B exposure-gex.json 133 KB exposure-dex.json 63 KB exposure-vex.json 63 KB exposure-chex.json 65 KB exposure-summary.json 1 KB exposure-levels.json 323 B exposure-narrative.json 1 KB exposure-zero-dte.json 29 KB exposure-sheet.json 99 KB exposure-term-structure.json 9 KB exposure-basket.json 920 B exposure-oi-diff.json 693 B maxpain.json 132 KB volatility.json 21 KB adv-volatility.json 558 KB vrp.json 2 KB vrp-history.json 7 KB liquidity.json 5 KB volatility-skew-term.json 8 KB volatility-spot-vol-correlation.json 286 B volatility-realized.json 375 B volatility-forecast.json 654 B dispersion.json 588 B expected-move.json 5 KB macro-vix-state.json 248 B universe.json 9 KB pricing-greeks.json 799 B pricing-iv.json 285 B pricing-kelly.json 966 B flow-summary.json 345 B flow-levels.json 253 B flow-pin-risk.json 393 B flow-gex.json 169 KB flow-dex.json 80 KB flow-dealer-risk.json 699 B flow-oi.json 316 B flow-live.json 1 KB flow-signals.json 32 KB flow-signals-summary.json 7 KB flow-options-recent.json 89 B flow-options-summary.json 280 B flow-options-blocks.json 84 B flow-options-history.json 21 KB flow-options-cumulative.json 48 KB flow-stocks-recent.json 89 B flow-stocks-summary.json 250 B flow-stocks-blocks.json 86 B flow-stocks-history.json 24 KB flow-stocks-cumulative.json 47 KB flow-stocks-bars.json 3 KB flow-options-leaderboard.json 138 B flow-options-outliers.json 167 B flow-stocks-leaderboard.json 138 B flow-stocks-outliers.json 167 B earnings-calendar.json 38 KB earnings-dealer-positioning.json 825 B earnings-strategies.json 292 B structures-pnl.json 3 KB structures-greeks.json 540 B screener.json 2 KB screener-fields.json 3 KB

How to use these

Feed the spec to an LLM

Download api.md (live endpoints), historical.md (point-in-time replay), or risk-engine.md (Risk Engine open beta - every flag and error code) and drop them into Claude, ChatGPT, Cursor, or your own agent's system prompt. All files are designed to be complete, self-contained references.

Wire samples into tests or mocks

Each JSON file under /docs/samples/ is a real response the live API returned for SPY. Use them as:

Fixtures for SDK unit tests
Mock payloads for UI development
Schema inputs for codegen
Reference when building client-side types

# Python example - load a sample
import json, urllib.request
url = "https://flashalpha.com/docs/samples/exposure-gex.json"
sample = json.loads(urllib.request.urlopen(url).read())

Historical endpoints use the same shape (plus dedicated samples + OpenAPI)

The analytics endpoints (52 replay routes; earnings, screener and structures are live-only) are mirrored on historical.flashalpha.com with a required ?at=yyyy-MM-ddTHH:mm:ss query parameter (Alpha tier). Response shapes are identical to live, so the same SDK code works against both. Two extra artifacts make backtest and codegen workflows easier:

historical.openapi.json - OpenAPI 3.1 spec with historical.flashalpha.com as the server and at marked required on every analytics path. Feed to Swagger UI, openapi-generator, or any LLM doing code synthesis.
historical-*.json - real captures from historical.flashalpha.com, frozen at at=2024-08-05T10:30:00 (the August 2024 carry-unwind / VIX spike). Every numeric value is what the API actually returned for that timestamp - not illustrative or fabricated. Use them as a reproducible point fixture for tests; pull a fresh capture for any other moment. Files: coverage, GEX, VRP, max pain, exposure summary, option chain (single expiry, full greeks + svi_vol), stock summary. Plus historical-stock-prices.json - daily OHLC bars backing the realized / forecast vol endpoints (a rolling window via days=N, not at=-frozen).

See the Historical API docs for coverage and field-level caveats.

What's in the .zip

api.md - full live-API spec in Markdown
historical.md - full Historical API spec
70 live *.json files, one per live endpoint, real responses for SPY (earnings samples use GME; realized/forecast use AAPL) - covers market data (stockquote, optionquote, surface-svi), exposure analytics (including exposure-sheet, term-structure, basket, oi-diff), volatility/VRP (skew-term, spot-vol-correlation, volatility-realized, volatility-forecast, dispersion, expected-move, vrp-history), macro + universe, pricing helpers (pricing-greeks, pricing-iv, pricing-kelly), the 25-endpoint Flow Analytics + Raw Flow Data surface (including flow-signals, flow-stocks-bars), earnings, multi-leg structures, the screener, and reference data
8 historical-*.json files for the point-in-time Historical API (incl. historical-stock-prices - rolling daily OHLC)
historical.openapi.json - OpenAPI 3.1 spec for the Historical API

Live samples are regenerated periodically; shape stability is guaranteed and specific values drift with the market. Historical samples are real captures from historical.flashalpha.com at a frozen at= anchor (currently 2024-08-05T10:30:00) - every value is what the API actually returned at that minute. They are reproducible test fixtures, not illustrative or fabricated.

How did you hear about us?