Options · Volatility
Options volatility risk premium
/v1/options/volatility/risk-premiumoptionsVolatilityRiskPremiumThe constant-maturity implied volatility (30 days by default) minus the realized volatility of the underlying over the last 10, 20 and 30 trading days, with where today's premium stands in its own history over the lookback: the z-score and the percentile (0 to 1, the share of days with a premium at or below today's). The series holds the daily implied volatility, the 20-day realized volatility and their difference. Volatilities are decimals. A premium needs a full window of returns; the stored history may be shorter than the lookback, and meta.coverage then says so. 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. Only series rows inside the window are returned; the z-score and percentile use the full lookback, and meta.coverage says when rows were withheld.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/volatility/risk-premium" \
-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/risk-premium?${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, 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 ... |
maturityqueryoptional | string714306090180365default 30 | Constant maturity of the volatility, in days: 7, 14, 30, 60, 90, 180 or 365. |
lookbackqueryoptional | integerdefault 250min 60max 250 | Trading days of premium history the z-score and percentile are measured over (and the series covers), 60 to 250; the stored record holds about one year. |
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 risk premium.15 fields insidecurrentarray<object>requiredWindows of 10, 20 and 30 trading days.6 fields insideivnumber | nullrequiredLatest implied volatility.percentilenumber | nullrequiredShare of days in the lookback with a premium at or below today's, 0 to 1.premiumnumber | nullrequirediv minus realized_vol.realized_volnumber | nullrequiredRealized volatility over the window.windowintegerrequiredTrading days of realized returns.z_scorenumber | nullrequiredHow many standard deviations today's premium is from its mean over the lookback.
lookback_daysintegerrequiredDays of history the statistics use.maturity_daysintegerrequiredConstant maturity of the implied volatility.seriesobjectrequiredDaily series over the lookback, oldest first.4 fields insidedatesarray<string>requiredDates.ivarray<number>requiredImplied volatility.premium_20array<number>requirediv minus realized_vol_20.realized_vol_20array<number>required20-day realized volatility.
underlying_symbolstringrequiredThe requested underlying.
metaobjectrequiredMeta object
Example response
{
"data": {
"current": [
{
"iv": 0.171,
"percentile": 0.72,
"premium": 0.05,
"realized_vol": 0.121,
"window": 20,
"z_score": 0.8
}
],
"lookback_days": 252,
"maturity_days": 30,
"series": {
"dates": [
"2026-10-15",
"2026-10-16"
],
"iv": [
0.169,
0.171
],
"premium_20": [
0.049,
0.05
],
"realized_vol_20": [
0.12,
0.121
]
},
"underlying_symbol": "SPX"
},
"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.
