Options · Order flow
Options flow implied volatility
/v1/options/flow/implied-volatilityoptionsFlowImpliedVolatilityFor each bucket, the implied volatility (decimal, 0.18 is 18%) at which customers bought and sold calls and puts, averaged over the directional, non-complex prints with each print's premium as the weight, and the premium behind each value. The volatility of a print is the one the platform solved at execution, not an exchange quote. A bucket without such premium has a null volatility. Totals over the window use the same weighting. Buckets that have not started yet are not returned. When no print of the request carries a volatility meta.coverage.complete is false.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/flow/implied-volatility" \
-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/flow/implied-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
6 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 ... |
datequeryoptional | stringdate | Trading date (YYYY-MM-DD). Default: the current session, else the most recent completed one. Overnight prints belong to the next trading date. |
sessionqueryoptional | stringrthgthalldefault rth | Trading session: rth is the regular session, gth the overnight (global trading hours) session before the trading date, all both. Overnight data requires the Pro plan and exists only for underlyings with an overnight session; GET /v1/options/sessions shows which. |
start_queryoptional | integerunix-msmin 946684800000max 4102444800000 | Start of the window (inclusive). The window must lie within one trading session; combine with date to name that session. |
end_queryoptional | integerunix-msmin 946684800000max 4102444800000 | End of the window (exclusive). |
intervalqueryoptional | string1m5m15m30m1hdefault 5m | Bucket length: 1m, 5m, 15m, 30m or 1h. |
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
dataobjectrequiredImplied volatility the flow traded at.25 fields insidebucketsarray<object>requiredOne entry per bucket that has started.13 fields insideimplied_volatilityobjectrequiredPremium-weighted volatility of the bucket, as a decimal; null without premium.6 fields insidecallnumber | nullrequiredAll calls.call_buynumber | nullrequiredCalls customers bought.call_sellnumber | nullrequiredCalls customers sold.putnumber | nullrequiredAll puts.put_buynumber | nullrequiredPuts customers bought.put_sellnumber | nullrequiredPuts customers sold.
premiumobjectrequiredThe premium in US dollars behind each volatility.4 fields insidecall_buynumber | nullrequiredCalls customers bought.call_sellnumber | nullrequiredCalls customers sold.put_buynumber | nullrequiredPuts customers bought.put_sellnumber | nullrequiredPuts customers sold.
timestampintegerunix-msrequiredStart of the bucket. Unix epoch milliseconds (UTC).
implied_volatilityobjectrequiredPremium-weighted volatility over the whole window, as a decimal.6 fields insidecallnumber | nullrequiredAll calls.call_buynumber | nullrequiredCalls customers bought.call_sellnumber | nullrequiredCalls customers sold.putnumber | nullrequiredAll puts.put_buynumber | nullrequiredPuts customers bought.put_sellnumber | nullrequiredPuts customers sold.
intervalstringrequiredBucket length.sessionstringrequiredSession.rthgthalltrading_datestringdaterequiredTrading date.underlying_symbolstringrequiredThe requested underlying.
metaobjectrequiredMeta object
Example response
{
"data": {
"buckets": [
{
"implied_volatility": {
"call": 0.152,
"call_buy": 0.152,
"call_sell": null,
"put": 0.17,
"put_buy": 0.171,
"put_sell": 0.168
},
"premium": {
"call_buy": 1200000,
"call_sell": 0,
"put_buy": 2100000,
"put_sell": 1400000
},
"timestamp": 1792161000000
}
],
"implied_volatility": {
"call": 0.15,
"call_buy": 0.151,
"call_sell": 0.148,
"put": 0.171,
"put_buy": 0.172,
"put_sell": 0.169
},
"interval": "5m",
"session": "rth",
"trading_date": "2026-10-16",
"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.
