Options Flow

Get Flow Series

Server-accumulated flow series — one row per 5-minute bar, or per 1-minute bar with timeframe=1min.

Returns cumulative call/put premium, volume, position, net volume, and put/call ratio per bar across all contracts matching the optional strikes/expirations filters. Rows are contiguous (quiet bars carry forward as synthetic rows flagged by is_synthetic). Frontend renders this series directly — no client-side accumulators.

Rows are ordered newest → oldest so rows[0] is the most recent bar. With intervals=N you get the leading N rows (the trailing-N most recent bars).

session=current is the most recent ET trading day that has any data for the symbol; session=prior is the ET day immediately before that. date=YYYY-MM-DD names any other day and overrides session. Unknown symbols return 404; symbols that exist but have no data for the requested session return 200 with [].

get/api/flow/series

Request

  • Base URL: https://api.zerogex.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.zerogex.io/api/flow/series
  • Auth: HTTP bearer

Query parameters

symbolstring required
session'current' | 'prior'
datestring nullable

An explicit ET trading day, YYYY-MM-DD. Overrides session. /api/flow/sessions lists the days that have data.

strikesstring nullable

Comma-separated strikes to include. Empty/missing = all strikes.

expirationsstring nullable

Comma-separated YYYY-MM-DD expirations to include. Empty/missing = all.

intervalsinteger nullable

If provided, return only the last N bars (tail window) for cheap incremental polling. A full regular session is 82 five-minute bars or 406 one-minute bars (09:30 through 16:15 ET, both ends included).

timeframe'5min' | '1min'

Bar size: '5min' (default) or '1min'. Both carry the same session-cumulative fields, so a 1-minute bar reads the same totals as the 5-minute bar it closes.

Response

Successful Response

timestampstring required
bar_startstring required
bar_endstring required
call_premium_cumnumber required
put_premium_cumnumber required
call_volume_cuminteger required
put_volume_cuminteger required
net_volume_cuminteger required
raw_volume_cuminteger required
call_position_cuminteger required
put_position_cuminteger required
net_premium_cumnumber required
put_call_rationumber nullable
underlying_pricenumber nullable
contract_countinteger required
is_syntheticboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.