v1

latestOpenAPI 3.1.02026-07-2655154175.6 KB
Flow

Per-ticker net-premium time series ("flow tide")

Bucketed bullish vs bearish premium time series for a single ticker, with cumulative net premium and per-bucket VWF/SDF/FIR. The ticker-level analogue of /v1/market/tide.

get/v1/flow/{ticker}/tide

Path parameters

tickerstring required
Example:SPY

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

start_timestring required
Example:2026-05-27T13:30:00Z

Lower bound of the window. Accepts RFC 3339 (2026-05-27T13:30:00Z) or Unix seconds.

end_timestring required
Example:2026-05-27T20:00:00Z

Upper bound of the window (RFC 3339 or Unix seconds).

bucket'1min' | '5min' | '15min' | '30min' | '1h'

Bucket size for the time series. Pre-aggregated tables back the sub-hourly resolutions. Coarser buckets (1d, 1w) are rejected on intraday endpoints.

option_type'call' | 'put' | 'all'
min_premiumnumber double
exclude_multi_legboolean
min_dteinteger
max_dteinteger
datestring date

Response

Per-bucket flow tide bars.

Example response

{
  "meta": {
    "requestId": "d7574836"
  }
}