Options Flow

Get Flow By Contract

Per-contract option flow in 5-min buckets with session-cumulative values.

Returns one row per (option_type, strike, expiration) per 5-min bucket. raw_volume, raw_premium, net_volume and net_premium are day-to-date cumulative for each contract as of the end of its bucket; counters reset at 09:30 ET (TradeStation RTH open).

session=current returns today's open session (or most recent if closed); session=prior returns the previous full session. Pass intervals=N to limit the response to the most recent N 5-minute buckets.

get/api/flow/by-contract

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/by-contract
  • Auth: HTTP bearer

Query parameters

symbolstring
sessionstring
intervalsinteger nullable

Number of trailing 5-minute buckets to return. Defaults to the entire session (09:30–16:15 ET, ~81 buckets). Capped at 390 (one trading day at 1-minute resolution) to bound DB load.

Response

Successful Response

timestampstring date-time required
symbolstring required
option_typestring required
strikestring required
expirationstring date required
dteinteger required
raw_volumeinteger required
raw_premiumstring required
net_volumeinteger required
net_premiumstring required
underlying_pricestring nullable

Changes

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