---
title: "Api V2 Flow Series Get"
method: GET
path: "/api/v2/flow/series"
tags: ["Options Flow (v2)"]
---

# Api V2 Flow Series Get

`GET /api/v2/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/v2/flow/series`
- Auth: HTTP bearer

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 ``[]``.

## Query parameters

- `symbol` string, required
- `session` 'current' | 'prior'
- `date` string, nullable: An explicit ET trading day, YYYY-MM-DD. Overrides `session`. `/api/flow/sessions` lists the days that have data.
- `strikes` string, nullable: Comma-separated strikes to include. Empty/missing = all strikes.
- `expirations` string, nullable: Comma-separated YYYY-MM-DD expirations to include. Empty/missing = all.
- `intervals` integer, 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 `200`

Successful Response

- EnvelopeListFlowSeriesPoint
  - `data` FlowSeriesPoint[], required
    - `timestamp` string, required
    - `bar_start` string, required
    - `bar_end` string, required
    - `call_premium_cum` number, required
    - `put_premium_cum` number, required
    - `call_volume_cum` integer, required
    - `put_volume_cum` integer, required
    - `net_volume_cum` integer, required
    - `raw_volume_cum` integer, required
    - `call_position_cum` integer, required
    - `put_position_cum` integer, required
    - `net_premium_cum` number, required
    - `put_call_ratio` number, nullable
    - `underlying_price` number, nullable
    - `contract_count` integer, required
    - `is_synthetic` boolean, required
  - `freshness` Freshness, required: The v2 freshness envelope. Present on every ``/api/v2/*`` response.
    - `evaluated_at` string, date-time, required: When the API evaluated this response (server wall clock, UTC). Endpoint-health signal: advances on every request even when the underlying data is unchanged.
    - `generated_at` string, date-time, required: When the served data was computed. Equals the snapshot stamp for cycle-backed endpoints, or evaluated_at for endpoints computed on demand for this request.
    - `source_timestamp` string, date-time, nullable: Timestamp of the upstream market observation the payload derives from. This is what freshness_status is measured against. Null when the endpoint has no upstream feed or returned no rows.
    - `latest_event_at` string, date-time, nullable: Newest event timestamp present in the payload (last bar, last trade, last scored row). Best-effort on very large responses, which are sampled rather than fully walked.
    - `age_seconds` number, nullable: evaluated_at - source_timestamp, in seconds. Null when source_timestamp is null.
    - `market_session_status` string, required: pre-market | regular | after-hours | closed (US/Eastern).
    - `expected_update_cadence` string, nullable: ISO-8601 duration for how often this endpoint's data is expected to change right now, e.g. PT60S. Null means no updates are expected (weekend, holiday, or a feed that only runs during the session).
    - `expected_update_cadence_seconds` number, nullable: expected_update_cadence as a number of seconds.
    - `cadence_profile` string, required: Identifier of the cadence class this endpoint belongs to, e.g. analytics_cycle. Stable across releases; the seconds behind it may be retuned.
    - `stale_after` string, date-time, nullable: Instant after which this payload should be treated as stale. Null whenever expected_update_cadence is null.
    - `freshness_status` 'fresh' | 'aging' | 'stale' | 'session_closed' | 'static' | 'unknown', required: The rolled-up freshness verdict for one response. ``fresh`` ``source_timestamp`` is within one expected update cadence. ``aging`` Past one cadence but not yet past ``stale_after`` — the grace band that absorbs normal cycle jitter. Not an error; a client that polls faster than the cadence sees this routinely. ``stale`` Past ``stale_after`` while updates *were* expected. This is the actionable state: the feed behind this endpoint is late. ``session_closed`` A feed-backed endpoint whose feed is not due to produce anything right now (weekend, holiday, or a feed that only runs during the session). The payload is the last good value — deliberately NOT reported as ``stale``, because an overnight consumer polling a closed market is not observing a fault and should not page on it. ``static`` The endpoint is not feed-backed at all: completed history, or a result computed from the caller's own inputs. Age here carries no health meaning and never becomes a fault. ``unknown`` No source timestamp could be resolved from the payload (e.g. a pure calculator, an admin endpoint, or an empty result set). A consumer should fall back to ``evaluated_at`` for endpoint health and make no claim about data age.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/zerogex/apis/zerogex-api.md) · [All operations](https://skmtc.dev/zerogex/apis/zerogex-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zerogex/apis/zerogex-api/revisions/753b26bf0592?raw)