Futures · Statistics
Futures volatility
/v1/futures/volatilityfuturesVolatilityAnnualised realized volatility from today's one-minute log returns (the zero-mean estimator over 252 x 1,380 minutes a year; null under 30 returns; a minute without trades has no bar, so only returns between consecutive minutes count) and from the daily closes of the last window completed sessions (sample standard deviation, 252 sessions a year); Parkinson volatility from their highs and lows; the average true range (Wilder, over the last 14 completed sessions, or all of them when fewer are held) and the average daily range in points and ticks; and today's range and its share of the average daily range. One daily read covers at most 21 completed sessions, so a larger window is cut to that and fewer than 5 sessions leave the daily figures null; coverage.sessions_used tells how many were used. Reads through a deferred history read, so a first request can answer 503 data_pending; retry. The figures use a longer lookback than the dated rows your plan's history window allows (the window limits the rows returned, not the lookback a statistic is computed from); this route returns no dated rows.
Example request
curl -sS --get "https://api.ordermap.si/v1/futures/volatility" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=ESconst params = new URLSearchParams({
symbol: "ES",
});
const res = await fetch(`https://api.ordermap.si/v1/futures/volatility?${params}`, {
headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.
Parameters
3 parameters, none required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryoptional | stringat most 3 characterspattern ^[A-Za-z0-9]{1,3}$ | Futures product root, for example ES, NQ, CL or GC. Without contract the current front month is used and returned in the response. |
contractqueryoptional | stringat most 6 characterspattern ^[A-Za-z0-9]{1,3}[FGHJKMNQUVXZfghjkmnquvxz][0-9]{1,2}$ | Exact dated contract: root, month code and year, for example ESZ6 (December 2026). Two-digit years are accepted and returned in the one-digit form (ESZ26 is ESZ6). Only the front month and the contracts listed by /v1/futures/contracts are served. |
windowqueryoptional | integerdefault 20min 5max 22 | Completed sessions the daily figures use. |
Response
| Status | Meaning | Body |
|---|---|---|
200 | Successful response. | Schema below |
400 | Invalid, unknown or repeated parameters, or an invalid cursor. | Error object |
401 | Missing or invalid API key. | Error object |
403 | The plan, dataset release or account state does not allow this request. | Error object |
422 | The request is valid but no data exists for it. | Error object |
429 | Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After | Error object |
500 | Internal error. | Error object |
503 | Data temporarily unavailable; retry after Retry-After seconds.Retry-After | Error object |
504 | The request timed out. | Error object |
Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.
200 response body
dataobjectrequiredVolatility of one contract.10 fields insideatrnumber | nullrequiredAverage true range of the daily bars, in points.atr_ticksnumber | nullrequiredatr in ticks.average_daily_rangenumber | nullrequiredMean of high minus low over the daily bars, in points.average_daily_range_ticksnumber | nullrequiredaverage_daily_range in ticks.contractstring | nullrequiredDated contract.parkinson_volnumber | nullrequiredAnnualised range-based (Parkinson) volatility of the daily bars.realized_vol_dailynumber | nullrequiredAnnualised volatility of the daily close-to-close log returns.realized_vol_intradaynumber | nullrequiredAnnualised volatility of today's one-minute log returns.today_rangenumber | nullrequiredToday's high minus low, in points.today_range_sharenumber | nullrequiredtoday_range divided by average_daily_range.
metaobjectrequiredMeta object
Example response
{
"data": {
"atr": 58.4,
"atr_ticks": 233.6,
"average_daily_range": 61.2,
"average_daily_range_ticks": 244.8,
"contract": "ESZ6",
"parkinson_vol": 0.124,
"realized_vol_daily": 0.131,
"realized_vol_intraday": 0.142,
"today_range": 43.5,
"today_range_share": 0.71
},
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "cme"
}
}Values are illustrative. Missing values are null, never 0.
