Forced Flow

Get Session Surface

Full-session forced-flow field: the ACTUAL historical field recomputed from stored option_chains (RTH open -> now) plus a projection of the current book (now -> close).

Columns march left (open) to right (close); now_index marks the boundary between recorded history and projection. History is rebuilt from option_chains because the persisted forced_flow_profile.profile JSONB is written empty -- so the past field cannot be read back, only recomputed.

get/api/forced-flow/session-surface

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/forced-flow/session-surface
  • Auth: HTTP bearer

Query parameters

symbolstring
spot_range_pctnumber
past_stepsinteger

Actual-history columns

future_stepsinteger

Projection columns to close

expirystring nullable

Response

Successful Response

symbolstring required
spotnumber required
timestampstring date-time required
session_open_min_to_closenumber required
now_min_to_closenumber required
pricesnumber[] required
now_indexinteger required

Changes

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