Flow Summary API

Endpoint

Parameters

Request

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

import requests

resp = requests.get(
    "https://lab.flashalpha.com/v1/flow/summary/SPY",
    headers={"X-Api-Key": "YOUR_API_KEY"}
)
resp.raise_for_status()
data = resp.json()
print(f"Flow direction: {data['flow_direction']}")
print(f"Live GEX: ${data['live_gex']:,.0f}")

const resp = await fetch(
  "https://lab.flashalpha.com/v1/flow/summary/SPY",
  { headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();
console.log(`Flow direction: ${data.flow_direction}`);
console.log(`Live GEX: $${data.live_gex.toLocaleString()}`);

{
  "symbol": "SPY",
  "as_of": "2026-10-30T13:46:09.3154414Z",
  "underlying_price": 760.225,
  "expiry": null,
  "flow_direction": "neutral",
  "intraday_oi_delta": 24615,
  "contracts_with_flow": 1385,
  "contracts_total": 12318,
  "live_gex": -15649324149,
  "flow_gex_pct_shift": -0.001363,
  "endpoint_version": "2026.09.30",
  "data_as_of": {
    "node": "fa4",
    "equity_feed": "2026-10-30T13:46:08.984Z",
    "equity_options_feed": "2026-10-30T13:46:08Z",
    "index_feed": "2026-10-30T13:46:08.091Z",
    "index_options_feed": "2026-10-30T13:46:03Z",
    "futures_feed": "2026-10-30T13:46:07.407Z",
    "futures_options_feed": "2026-10-30T13:45:49.971Z",
    "flow_feed": "2026-10-30T13:45:00Z",
    "oi_feed": "2026-10-29T20:00:00Z",
    "macro_feed": "2026-10-29T21:00:20Z"
  }
}

Response Fields

Errors

About the Flow Summary

The Flow Summary returns the single line you'd put at the top of a trading dashboard: how flow is reshaping dealer positioning right now. Unlike /v1/exposure/summary - which is computed on the morning OPRA-broadcast (settled) open interest and stays static through the session - this endpoint runs the same dealer-GEX math on the OI simulator's effective OI, so the value updates intraday as positioning shifts. The flow_direction label and flow_gex_pct_shift together tell you whether dealers are getting longer gamma, shorter gamma, or flipping regime versus the morning baseline.

Common Use Cases

• Headline a dashboard - render flow_direction plus flow_gex_pct_shift as one line ("flow has amplified dealer GEX 9.4% since open") instead of explaining four endpoints
• Alert on regime shifts - fire when flow_direction becomes regime_flip so you catch the moment dealers cross from long to short gamma
• Detect a stale settled picture - watch flow_gex_pct_shift to know when the morning OPRA-settled GEX has stopped being representative and live positioning has diverged
• Overlay flow confirmation - combine flow_direction with directional signals to filter out trades that fight intraday repositioning
• Poll cheaply across a watchlist - one lightweight call per symbol answers "is anything interesting happening today" before you spend budget on the full bundle
• Track the intraday OI delta - read intraday_oi_delta to gauge how much fresh positioning has built since open and weight the flow signal accordingly

Related

Related reading

• Options flow API: recent trades, blocks & leaderboard - the underlying flow this summary distils
• Flow vs exposure endpoints: which GEX API to use - when to read live flow GEX vs settled exposure

Complementary endpoints

• Flow Live - the full bundle when the headline says something is happening
• Flow Signals - the scored prints driving the direction the summary reports
• Live Flow GEX - the per-strike live dealer-gamma behind flow_gex_pct_shift
• Live Flow Levels - intraday support/resistance updated by the same OI simulator