v1

latestOpenAPI 3.1.02026-07-2655154175.6 KB
Underlying

Relative-volume bars for a ticker

Time-bucketed bars with call/put volume + premium and an average-volume baseline computed from avgPeriod recent days, plus aggregate RVOL stats.

get/v1/underlying/{ticker}/rvol

Path parameters

tickerstring required
Example:SPY

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

Query parameters

intervalstring
Example:1D

Trailing window — {N}D where N is 1–365 (e.g. 1D, 7D, 30D).

bucket'1min' | '5min' | '10min' | '15min' | '30min' | '1d' | '1w'
avg_periodstring

Baseline lookback as {N}d (e.g. 14d, 30d). Max 365 days.

datestring date
Example:2026-05-27

Trading date the request targets, in YYYY-MM-DD. Defaults to the current trading date (the most recent session that has settled enough data to be queryable). Past dates fall through to the daily rollup tables.

order_by'rvol' | 'volume' | 'premium' | 'time'
order'asc' | 'desc'

Sort direction. Defaults to asc when order_by=time, otherwise desc.

limitinteger
format'full' | 'summary'

Response

RVOL bars + aggregate stats.

Example response

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