Premium by side, name and sector.
/v1/symbols/{symbol}/flowSigned call and put premium, bullish and bearish premium, one-minute buckets by moneyness, and how much of today's volume has a known side.
symbolstringrequiredThe ticker: SPY, SPX, NDX, AAPL …
series1default 01 adds the cumulative signed-premium path (net drift).
bucketsstringdefault allOnly the newest N one-minute buckets, 0 to 1440 (0: none, totals and classification only). The stream's flow family carries ?buckets=1 (the minute that changes) and its drift family ?buckets=0&series=1; the day's buckets are this GET once.
datedateTrading date, Eastern.
totals.signed_call_premium, signed_put_premiumnumberUSDBuys minus sells per side, today.
totals.bullish_premium, bearish_premiumnumberUSDCall buys + put sells; call sells + put buys.
totals.net_premiumnumberUSDbullish − bearish.
buckets[].ts, ts_mstimestampStart of the minute.
buckets[].spotnumberUSDSpot during the minute.
buckets[].classified_tradesintegerPrints with a known side in the minute.
buckets[].all, itm, atm, otmobjectsigned_call_premium, signed_put_premium (USD) and signed_call_contracts, signed_put_contracts (contracts), buys minus sells, for all prints and by moneyness.
classification.classified_trades, unclassified_tradesintegerToday.
classification.coveragenumberfractionShare of today's volume with a known side.
/v1/flow/leadersUnderlyings or single contracts ranked by premium, volume, trades, sweeps or direction over a finished session or its week, each against its own baseline.
datestringA finished session, YYYY-MM-DD.
windowenumdefault dayday or week.
byenumdefault premiumpremium, volume, trades, sweeps, bullish, bearish.
kindenumdefault underlyingsunderlyings, or contracts with window=day.
limitintegerdefault 25Rows, 1 to 200.
date, window, sessions[], by, kind, countrows[].symbolstringrows[].premium, call_premium, put_premiumnumberUSDrows[].volume, call_volume, put_volume, tradesintegercontracts, printsrows[].bullish_premium, bearish_premiumnumberUSDrows[].imbalancenumberfractionrows[].sweep_trades, sweep_premiuminteger, numberprints, USDrows[].spotnumberUSDrows[].premium_relative, volume_relativenumberfractionrows[].baseline_sessionsintegersessionscontracts: rows[].contract, expiration, right, strikestring, date, string, numberUSD (strike)meta.table_date, meta.table_sessionsdate, integer/v1/flow/sectors/v1/flow/breadth/v1/flow/unusualFlow by sector against each sector's baseline, advancing and declining names by premium imbalance, and contracts trading a multiple of their usual volume.
datestringA finished session, YYYY-MM-DD.
thresholdnumberBreadth: the imbalance beyond which a name advances or declines, 0 to 1.
min_volume_relativenumberUnusual: how many times its usual volume a contract trades, at least.
min_volumeintegerUnusual: contracts traded, at least.
limitintegerdefault 100Unusual: rows, 1 to 500.
date, countrows[].sectorstringrows[].symbolsintegernamesrows[].premium, call_premium, put_premium, bullish_premium, bearish_premiumnumberUSDrows[].volumeintegercontractsrows[].imbalancenumberfractionrows[].baseline_symbolsintegernamesrows[].premium_relativenumberfractiondate, threshold, symbolsadvancing, declining, neutralintegernamesadvance_decline_rationumberratiopremium, bullish_premium, bearish_premiumnumberUSDimbalancenumberfractionmajors.{SPY,QQQ,IWM,DIA}.premium, .imbalancenumberUSD, fractiondate, min_volume_relative, min_volume, countrows[].contract, symbol, expiration, right, strikestring, string, date, string, numberUSD (strike)rows[].volume, tradesintegercontracts, printsrows[].premiumnumberUSDrows[].imbalancenumberfractionrows[].spotnumberUSDrows[].baseline_sessionsintegersessionsrows[].volume_relativenumberfraction/v1/symbols/{symbol}/flow/baseline/v1/symbols/{symbol}/flow/historyOne session against the symbol's own baseline, by day and through the day; and its flow totals per session.
symbolstringrequiredThe ticker: SPY, SPX, NDX, AAPL …
datestringA finished session, YYYY-MM-DD.
daysintegerdefault 20flow/history: sessions, 1 to 60.
symbol, datebaseline.sessionsintegersessionssessionobjectslots[].timestringETslots[].premium, bullish_premium, bearish_premiumnumberUSDslots[].volume, tradesintegercontracts, printsslots[].imbalancenumberfractionslots[].premium_relativenumberfractionsymbol, date, countrows[].datedaterows[].premium, call_premium, put_premiumnumberUSDrows[].volume, call_volume, put_volumeintegercontracts