Options · Volatility
Options volatility spot correlation
/v1/options/volatility/spot-correlationoptionsVolatilitySpotCorrelationThe Pearson correlation between the underlying's daily log returns and the day-to-day changes of the constant-maturity implied volatility (30 days by default) over the last 20 and 60 days with both a return and a change, and how many days were used. A strongly negative figure is the usual equity pattern: volatility rises when the price falls. A window without enough days, or with a constant series, is null. 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/spot-correlation" \
-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/spot-correlation?${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
2 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. |
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
dataobjectrequiredSpot and implied volatility correlation.6 fields insidematurity_daysintegerrequiredConstant maturity of the implied volatility.underlying_symbolstringrequiredThe requested underlying.windowsarray<object>requiredWindows of 20 and 60 days.3 fields insidecorrelationnumber | nullrequiredCorrelation, -1 to 1; null without a full window or with a constant series.observationsintegerrequiredDays with both a return and a change, at most the window.windowintegerrequiredDays.
metaobjectrequiredMeta object
Example response
{
"data": {
"maturity_days": 30,
"underlying_symbol": "SPX",
"windows": [
{
"correlation": -0.82,
"observations": 20,
"window": 20
},
{
"correlation": -0.77,
"observations": 60,
"window": 60
}
]
},
"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.
