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

# Api V2 Flow Hedging Get

`GET /api/v2/flow/hedging`

## 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/hedging`
- Auth: HTTP bearer

Estimated dealer hedging pressure per 5-minute bar, with sign flips.

The aggressor-inferred companion to ``/api/flow/series``: for every option
that traded, the net customer position change is converted to the stock a
delta-flat hedge implies (``(buy - sell) * delta * 100 * spot``) and
accumulated across the session. Positive means the hedge BUYS stock --
the same sign convention and units as the Forced Flow engine, so the
modeled and estimated sources are directly additive.

``call_flow_usd`` / ``put_flow_usd`` split the pressure by the option type
that produced it, not by its direction: customers selling puts push the
net positive and land in the put series.

``flips`` carries two kinds. ``rate`` flips are the smoothed per-bar
series changing sign -- the immediate push turning over, and the frequent
one. ``cumulative`` flips are the session's net lean crossing zero: rare,
and context rather than a trigger.

A flip requires the series to ESTABLISH itself outside a flat band around
zero (``flat_band``), not merely to touch the far side. Without that, a
rate hovering near zero reports a direction change on every nick across
it, which on a live session buried the real turns among a dozen dots even
with the significance filter applied.

Same session resolution, 5-minute grid and unfiltered underlying price as
``/api/flow/series``, so the two overlay bar-for-bar. Rows are newest →
oldest. Unknown symbols 404; known symbols with no session data return an
empty ``bars`` list.

This series is an ESTIMATE that assumes the passive side of each
classified print was a market maker. That assumption is under test and is
not established — see ``basis`` and ``disclosure`` in the payload, which
any rendering surface is expected to carry through.

## Query parameters

- `symbol` string, required
- `session` 'current' | 'prior'
- `date` string, nullable: An explicit ET trading day, YYYY-MM-DD. Overrides `session`. Served from the retention-exempt hedging_flow_5min snapshot, so it reaches back past the DATA_RETENTION_DAYS prune window that bounds the live pipeline. A day with nothing stored returns 200 with an empty `bars` list -- never 404.
- `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. Pass today's date to isolate 0DTE.
- `intervals` integer, nullable: If provided, return only the last N 5-minute bars (tail window).
- `smoothing` integer: Trailing SMA length in 5-minute bars for the rate line and flip detection. Default 3 (15 minutes).
- `significance` number: A rate flip is marked significant when its swing is at least this multiple of the session's own typical swing. Note the scale is a median, so 1.0 is the middle of the day's swings rather than the tail; raise it for only the largest turns.
- `flat_band` number: Half-width of the flat band around zero, as a multiple of the session's own typical rate. Values inside it count as flat rather than as a side, so a rate hugging zero stops producing a flip on every nick across it. 0 disables the band.

## Response `200`

Successful Response

- EnvelopeHedgingFlowResponse
  - `data` HedgingFlowResponse, required: Estimated hedging pressure across a session, plus its sign flips. ``basis`` and ``disclosure`` are part of the contract, not decoration. This series is AGGRESSOR-INFERRED: it assumes the passive side of every classified print was a market maker, an assumption that has not been validated against exchange-classified data (see ``docs/design/aggressor-inferred-positioning-experiment.md``). Any surface rendering this payload has to carry that through -- it is estimated hedging pressure, never observed dealer flow.
    - `symbol` string, required
    - `session` string, required
    - `basis` string, required
    - `disclosure` string, required
    - `smoothing_bars` integer, required
    - `flat_band_ratio` number, required
    - `bars` HedgingFlowBar[], required
      - `timestamp` string, required
      - `bar_start` string, required
      - `bar_end` string, required
      - `call_flow_usd` number, required
      - `put_flow_usd` number, required
      - `net_flow_usd` number, required
      - `net_flow_ma_usd` number, nullable
      - `cum_call_usd` number, required
      - `cum_put_usd` number, required
      - `cum_net_usd` number, required
      - `underlying_price` number, nullable
      - `contract_count` integer, required
      - `classified_ratio` number, nullable
      - `is_synthetic` boolean, required
    - `flips` HedgingFlowFlip[], required
      - `bar_start` string, required
      - `kind` string, required
      - `direction` string, required
      - `magnitude_usd` number, required
      - `session_ratio` number, required
      - `is_significant` boolean, required
      - `underlying_price` number, nullable
  - `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)