Options · Volatility
Options volatility cone
/v1/options/volatility/coneoptionsVolatilityConeFor the windows of 5, 10, 20, 30, 60, 90 and 120 trading days, the minimum, quartiles and maximum of the rolling realized volatility of the underlying over the stored history, today's value and the number of rolling observations, next to the constant-maturity implied volatility of the term structure. A window longer than the stored history has no cone. Volatilities are decimals; realized volatility is zero-mean close-to-close, annualised with 252. The statistics use the platform's daily record over up to 365 days whatever your plan's history window; the window limits the dated rows returned, not the lookback. This route returns no dated rows.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/volatility/cone" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode underlying_symbol=SPXWconst params = new URLSearchParams({
underlying_symbol: "SPXW",
});
const res = await fetch(`https://api.ordermap.si/v1/options/volatility/cone?${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
1 parameter, 1 required.
| Parameter | Type and limits | Description |
|---|---|---|
underlying_queryrequired | stringat most 8 characterspattern ^[A-Za-z][A-Za-z0-9.]{0,7}$ | Option root or family: SPX covers the SPX and SPXW roots, SPXW only the weekly root, QQQ, NDXP, RUTW, XSP ... |
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
dataobjectrequiredRealized-volatility cone.13 fields insideimpliedarray<object>requiredConstant-maturity implied volatility.2 fields insideivnumber | nullrequiredImplied volatility as a decimal.maturity_daysintegerrequiredDays.
underlying_symbolstringrequiredThe requested underlying.windowsarray<object>requiredWindows of 5, 10, 20, 30, 60, 90 and 120 trading days.8 fields insidecurrentnumber | nullrequiredRealized volatility over the newest window.maxnumber | nullrequiredHighest.mediannumber | nullrequiredMedian.minnumber | nullrequiredLowest rolling realized volatility.observationsintegerrequiredRolling windows in the sample.p25number | nullrequired25th percentile.p75number | nullrequired75th percentile.windowintegerrequiredTrading days of returns.
metaobjectrequiredMeta object
Example response
{
"data": {
"implied": [
{
"iv": 0.171,
"maturity_days": 30
}
],
"underlying_symbol": "SPX",
"windows": [
{
"current": 0.121,
"max": 0.402,
"median": 0.118,
"min": 0.061,
"observations": 232,
"p25": 0.092,
"p75": 0.151,
"window": 20
}
]
},
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "opra"
}
}Values are illustrative. Missing values are null, never 0.
