options-flow

Flow Tape

Filtered, cursor-paginated recorded-order tape, newest first.

Historical sessions require a ticker or occ filter — the session index is sorted by ticker, so an unfiltered historical read is a bulk export.

get/v1/options-flow/tape

Request

  • Base URL: https://api.optionwhales.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.optionwhales.io/v1/options-flow/tape
  • Auth: none declared

Query parameters

sessionstring nullable

Session YYYY-MM-DD; default live

tickerstring[] nullable

Underlying(s); required for historical

occstring[] nullable

OCC contract symbol(s)

typestring nullable

call | put

directionstring nullable

buy | sell

order_typestring nullable
min_contractsinteger
min_premiumnumber
min_confidencenumber nullable
dte_mininteger nullable
dte_maxinteger nullable
strike_minnumber nullable
strike_maxnumber nullable
expiry_fromstring nullable
expiry_tostring nullable
older_thanstring nullable

Cursor — rows strictly older

newer_thanstring nullable
limitinteger

Response

Successful Response

unknown required

Changes

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