- Live API Reference
- Flow Analytics
- Flow Signals
- Flow Signals Summary
Flow Signals Summary API
Net bullish vs bearish premium, opening vs closing premium, and the top-10 highest-scoring signals - in one cheap call you can fan across a watchlist for a smart-money tilt read.
Endpoint
X-Api-Key)
Rate Limited: Yes
Plan: Alpha+
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
symbol |
path | string | required | - | Underlying symbol |
windowMinutes |
query | integer | 240 |
Look-back window in minutes (1-10080). Non-numeric values return a 400 problem-details body. Out-of-range values are clamped to the supported range. | |
expiry |
query | date | all expiries | Filter the chain to a single expiry (yyyy-MM-dd). Invalid values return 400 invalid_expiry. An expiry with no data returns an empty result, not an error. |
Request
curl -H "X-Api-Key: YOUR_API_KEY" \
"https://lab.flashalpha.com/v1/flow/signals/NVDA/summary?windowMinutes=240"import requests
resp = requests.get(
"https://lab.flashalpha.com/v1/flow/signals/NVDA/summary",
params={"windowMinutes": 240},
headers={"X-Api-Key": "YOUR_API_KEY"}
)
resp.raise_for_status()
data = resp.json()
print(f"Signals: {data['signal_count']}")
print(f"Net directional: ${data['net_directional_premium']:,.0f}")
print(f"Opening / Closing: ${data['opening_premium']:,.0f} / ${data['closing_premium']:,.0f}")const resp = await fetch(
"https://lab.flashalpha.com/v1/flow/signals/NVDA/summary?windowMinutes=240",
{ headers: { "X-Api-Key": "YOUR_API_KEY" } }
);
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();
console.log(`Signals: ${data.signal_count}`);
console.log(`Net directional: $${data.net_directional_premium.toLocaleString()}`);Try it live
Runs on live market data and uses 1 request from your daily quota.
Response
{
"symbol": "NVDA",
"as_of": "2026-10-30T13:45:59.5475119Z",
"window_minutes": 240,
"expiry": null,
"underlying_price": 206.425,
"signal_count": 358,
"bullish_premium": 1804474,
"bearish_premium": 1529112,
"net_directional_premium": 275362,
"opening_premium": 11510599,
"closing_premium": 10651696,
"top_signals": [
{
"ts": "2026-10-30T13:30:51.343Z",
"expiry": "2026-11-04",
"strike": 230,
"right": "P",
"side": "buy",
"price": 22,
"size": 200,
"premium": 440000,
"dte": 5,
"structure": "block",
"aggressor": "at_ask",
"open_close_bias": "opening_bias",
"open_close_confidence": 0.43,
"contract_net_oi_delta": 86,
"intent": "bearish",
"score": 75,
"conviction": "medium",
"tags": [
"block",
"opening",
"golden"
],
"score_breakdown": {
"premium": 14,
"size_vs_oi": 18,
"aggressor": 14,
"sweep": 10,
"opening_bias": 9,
"tenor": 10
},
"enrichment": {
"iv": 0.469418,
"delta": -0.969288,
"gamma": 0.005935,
"iv_vs_atm": 0.117987,
"moneyness": "ITM",
"estimated_delta_notional": -4001705,
"hypothetical_gex_impact_if_opening": 50581.55
}
},
{
"ts": "2026-10-30T13:38:49.745Z",
"expiry": "2026-10-30",
"strike": 210,
"right": "C",
"side": "buy",
"price": 0.32,
"size": 1411,
"premium": 45152,
"dte": 0,
"structure": "sweep",
"aggressor": "at_ask",
"open_close_bias": "opening_bias",
"open_close_confidence": 0.43,
"contract_net_oi_delta": 371,
"intent": "bullish",
"score": 70,
"conviction": "medium",
"tags": [
"sweep",
"opening",
"0dte"
],
"score_breakdown": {
"premium": 12,
"size_vs_oi": 6,
"aggressor": 14,
"sweep": 18,
"opening_bias": 9,
"tenor": 11
},
"enrichment": {
"iv": 0.551843,
"delta": 0.123693,
"gamma": 0.067247,
"iv_vs_atm": 0.000175,
"moneyness": "OTM",
"estimated_delta_notional": 3602745,
"hypothetical_gex_impact_if_opening": 4043196
}
}
],
"endpoint_version": "2026.09.30",
"data_as_of": {
"node": "fa5",
"equity_feed": "2026-10-30T13:45:59.233Z",
"equity_options_feed": "2026-10-30T13:45:59Z",
"index_feed": "2026-10-30T13:45:59.095Z",
"index_options_feed": "2026-10-30T13:45:59Z",
"futures_feed": "2026-10-30T13:45:51.589Z",
"futures_options_feed": "2026-10-30T13:45:51.596Z",
"flow_feed": "2026-10-30T13:45:00Z",
"oi_feed": "2026-10-29T20:00:00Z",
"macro_feed": "2026-10-29T21:00:20Z"
}
}Sending request…
See this endpoint on live data
Send this exact request and the real response shows up here, right next to the example.
Top-level fields
| Field | Type | Description |
|---|---|---|
symbol / as_of | string | Symbol and ISO 8601 request timestamp |
window_minutes | number | Echo of the requested look-back window |
expiry | string, nullable | Echo of the requested expiry filter (null when aggregating across all expiries) |
underlying_price | number | Spot at request time (0 when the settled chain snapshot is unavailable) |
signal_count | number | Full count of signals in the window (not capped at 10) |
bullish_premium | number | Sum of premium across signals classified intent=bullish |
bearish_premium | number | Sum of premium across signals classified intent=bearish |
net_directional_premium | number | bullish_premium − bearish_premium |
opening_premium | number | Sum of premium across signals where open_close_bias = opening_bias |
closing_premium | number | Sum of premium across signals where open_close_bias = closing_bias |
top_signals | array | Up to 10 highest-scoring signals - same shape as /v1/flow/signals/{symbol} |
endpoint_version, data_as_of | string, object | Response envelope, see Response envelope. |
Fields of top_signals[]
| Field | Type | Description |
|---|---|---|
top_signals[].ts | string | Timestamp of the print, or of the last leg of a sweep (UTC) |
top_signals[].strike | number | Strike price |
top_signals[].right | string | Top signals: right |
top_signals[].side | string | Top signals: side |
top_signals[].price | number | Top signals: price |
top_signals[].size | number | Top signals: size |
top_signals[].premium | number | Top signals: premium |
top_signals[].dte | number | Days to expiration |
top_signals[].structure | string | Top signals: structure |
top_signals[].aggressor | string | Top signals: aggressor |
top_signals[].open_close_bias | string | Top signals: open close bias |
top_signals[].open_close_confidence | number | Top signals: open close confidence |
top_signals[].contract_net_oi_delta | number | Top signals: contract net OI delta |
top_signals[].intent | string | Top signals: intent |
top_signals[].score | number | Top signals: score |
top_signals[].conviction | string | Top signals: conviction |
top_signals[].tags | array of string | Top signals: tags |
top_signals[].score_breakdown | object | Top signals: score breakdown |
top_signals[].score_breakdown.premium | number | Score breakdown: premium |
top_signals[].score_breakdown.size_vs_oi | number | Score breakdown: size vs OI |
top_signals[].score_breakdown.aggressor | number | Score breakdown: aggressor |
top_signals[].score_breakdown.sweep | number | Score breakdown: sweep |
top_signals[].score_breakdown.opening_bias | number | Score breakdown: opening bias |
top_signals[].score_breakdown.tenor | number | Score breakdown: tenor |
top_signals[].enrichment | object | Top signals: enrichment |
top_signals[].enrichment.iv | number | Implied volatility |
top_signals[].enrichment.delta | number | Enrichment: delta |
top_signals[].enrichment.gamma | number | Enrichment: gamma |
top_signals[].enrichment.iv_vs_atm | number | Enrichment: IV vs ATM |
top_signals[].enrichment.moneyness | string | Enrichment: moneyness |
top_signals[].enrichment.estimated_delta_notional | number | Enrichment: estimated delta notional |
top_signals[].enrichment.hypothetical_gex_impact_if_opening | number | Enrichment: hypothetical GEX impact if opening |
top_signals[].expiry | string | The contract's own expiry date (yyyy-MM-dd, never null) |
Errors
| Status | Error | When |
|---|---|---|
400 | invalid_expiry | expiry is not a valid yyyy-MM-dd date. |
400 | - | A query value has the wrong type, or a required value is missing. The body is an RFC 7807 problem-details object with errors.<param>. |
401 | - | Missing or invalid X-Api-Key. The body is empty; check the status code before parsing JSON. |
403 | tier_restricted | Your plan is below Alpha. The body includes current_plan and required_plan. |
429 | Quota exceeded | Daily quota used up. Retry-After gives the seconds until the reset at 00:00 UTC. Rejected requests (including 403) count toward the quota. |
About the Summary
The summary is the watchlist-scale version of /v1/flow/signals. The full feed is great for a single name, but quickly gets expensive when you want a tilt read on 50 symbols. The summary aggregates the same scored signals into five headline premium roll-ups and embeds only the 10 highest-scoring signals so the response stays tight.
The net_directional_premium tells you whether bullish or bearish flow dominated the window. The opening_premium vs closing_premium split tells you whether positioning is being established or unwound - a high net-directional with a high opening share is the cleanest tilt read.
Common Use Cases
- Run a watchlist tilt scanner - fan across a universe and rank by
net_directional_premium / underlying_pricefor size-adjusted bullishness, surfacing the names worth a closer look - Build a sector flow dashboard - roll up signal-summary calls across a sector ETF's holdings to spot rotation between bullish and bearish premium
- Decompose positioning - diff
opening_premiumagainstclosing_premiumto separate fresh positioning from unwinds, and treat high-opening with high net-directional as the cleanest tilt - Gate the full feed cheaply - poll the summary, then call
/v1/flow/signalsonly whensignal_countornet_directional_premiumcrosses a threshold - Preview the leaders - inspect the embedded
top_signalsto see which strikes and structures drove the tilt without a second request - Generate a daily report - take an end-of-day snapshot with
windowMinutes=390for a one-line-per-name flow tilt across the book
Related
Related reading
- Flow signals API: scoring unusual options activity - how each signal is scored and classified before it rolls into these premium totals
- Build an unusual options activity scanner in Python - a worked watchlist scanner driven by the summary endpoint
Complementary endpoints
- Flow Signals - the full scored feed the summary aggregates
- Flow Summary - premium and volume roll-ups across the whole tape
- Flow Live Bundle - the raw real-time prints behind the signals
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