Options · Levels
Options levels events
/v1/options/levels/eventsoptionsLevelsEventsThe moments of a session at which the modeled key levels changed, from the retained minute timeline: the call wall or the put wall moved to another strike (from and to are the strikes), or the underlying price crossed the gamma flip level (from and to are the prices before and after, level is the flip). Steps without a valuation are skipped, and a change is compared with the last step that had a value. Regime changes and max pain moves are not in the timeline and are not reported. Sessions older than the retained timelines are not available. Dealer positioning is a model, not observed: with classic_oi the dealer is assumed long the calls and short the puts of the open interest, with flow_adjusted the classified prints since the open interest date adjust it. Public open interest does not identify who holds a position, so the values are estimates of exposure under that assumption.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/levels/events" \
-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/levels/events?${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
10 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 most recent session. |
sessionqueryoptional | stringrthgthdefault rth | Trading session: rth is the regular session, gth the overnight (global trading hours) session before the trading date. Overnight data requires the Pro plan and exists only for underlyings with an overnight session; GET /v1/options/sessions shows which. |
contract_queryoptional | stringcallput | Calls or puts. Omit for both. |
date_queryoptional | stringdate | Only this expiration. |
min_queryoptional | integermin 0max 3650 | Minimum days to expiration (0 = expires on the trading date). |
max_queryoptional | integermin 0max 3650 | Maximum days to expiration. |
intervalqueryoptional | string5m15m30m1hdefault 5m | Step length: 5m, 15m, 30m or 1h (the gamma flip needs at least 5m). |
unitqueryoptional | stringper_percentper_dollarrawdefault per_percent | Scale of the net exposure. |
modelqueryoptional | stringclassic_oiflow_adjusteddefault classic_oi | Dealer positioning model. |
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
dataarray<object>required6 fields insidefromnumber | nullrequiredThe strike before (a wall move) or the underlying price before (a crossing).kindstringrequiredcall_wall_moved, put_wall_moved or zero_gamma_crossed.call_wall_movedput_wall_movedzero_gamma_crossedlevelnumber | nullrequiredThe gamma flip level crossed; null for a wall move.spotnumber | nullrequiredUnderlying price at the step.timestampintegerunix-msrequiredTime of the step at which the change was seen. Unix epoch milliseconds (UTC).tonumber | nullrequiredThe strike after or the underlying price after.
metaobjectrequiredMeta object
Example response
{
"data": [
{
"from": 6000,
"kind": "call_wall_moved",
"level": null,
"spot": 6021.4,
"timestamp": 1792161300000,
"to": 6050
}
],
"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.
