Options · Exposure
Options exposure scenario
/v1/options/exposure/scenariooptionsExposureScenarioReprices every contract of the selection for each combination of an underlying price move (percent) and a parallel move of all implied volatilities (volatility points) and returns the net modeled dealer delta and gamma exposure of each cell, with the underlying price of the cell. The contracts keep their strikes and implied volatilities shifted in parallel (sticky strike); time to expiration and carry are unchanged. The cell with a spot move of 0 and a volatility move of 0 is the current exposure. A shifted volatility outside the range the model supports is clamped and meta.coverage reports it as incomplete. The grid has at most 45 cells. Values are model outputs, not forecasts. 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. With the flow_only model the dealer position is the classified prints since the open interest date alone.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/exposure/scenario" \
-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/exposure/scenario?${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
15 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. |
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. |
expirationsqueryoptional | array<string>comma-separated in one parameter1 to 64 itemseach at most 128 characterspattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ | Only these expirations, comma separated (YYYY-MM-DD), at most 64. Unlisted dates are ignored. |
expiry_queryoptional | string0dte1dteweeklymonthlylte30lte90 | Expiration set: 0dte, 1dte, weekly (within 7 days), monthly (third-Friday expirations), lte30 or lte90 (within 30 or 90 days). |
min_queryoptional | integermin 0max 3650 | Minimum days to expiration (0 = expires on the trading date). |
max_queryoptional | integermin 0max 3650 | Maximum days to expiration. |
unitqueryoptional | stringper_percentper_dollarrawdefault per_percent | Scale of the values: per_percent (dollars of dealer hedging per 1% move of the underlying), per_dollar (per $1 move) or raw (shares, or per unit of the greek). The dollar-valued Greeks do not scale with it. |
modelqueryoptional | stringclassic_oiflow_adjustedflow_onlydefault classic_oi | Dealer positioning model: classic_oi (open interest, calls long and puts short), flow_adjusted (adjusted by classified prints since the open interest date) or flow_only (those prints alone, without the open interest). |
perspectivequeryoptional | stringdealercustomerdefault dealer | dealer (default) or customer, which negates the values only. |
spot_queryoptional | array<string>comma-separated in one parameter1 to 9 itemseach at most 128 characterspattern ^-?[0-9]+(\.[0-9]+)?$ | Moves of the underlying price to value, in percent, at most 9, each between -50 and 50 (for example -2,-1,0,1,2). Default: -3,-2,-1,-0.5,0,0.5,1,2,3. |
vol_queryoptional | array<string>comma-separated in one parameter1 to 5 itemseach at most 128 characterspattern ^-?[0-9]+(\.[0-9]+)?$ | Parallel moves of every implied volatility to value, in volatility points, at most 5, each between -50 and 50. Default: -5,-2,0,2,5. |
timestampqueryoptional | integerunix-msmin 946684800000max 4102444800000 | Value the snapshot at this retained minute (Unix milliseconds) instead of the latest. The minute must lie in a session whose history your plan covers; with date it must fall in that session. An instant outside the regular hours is read from the overnight session unless session is given. |
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
dataobjectrequiredModeled exposure over a scenario grid.26 fields insidecellsarray<object>requiredOne cell per volatility move and spot move, volatility moves outermost, both ascending.5 fields insidedelta_exposurenumber | nullrequiredNet modeled dealer delta exposure after the moves.gamma_exposurenumber | nullrequiredNet modeled dealer gamma exposure after the moves.spot_move_percentnumberrequiredMove of the underlying price in percent.underlying_pricenumber | nullrequiredUnderlying price after the move.vol_move_pointsnumberrequiredParallel move of every implied volatility, in volatility points.
modelstringrequiredDealer positioning model.classic_oiflow_adjustedflow_onlyperspectivestringrequireddealer or customer (customer negates the values).dealercustomerpositioning_modelstringrequiredName and version of the positioning assumption, for example oi_signed_proxy-v1.rootsarray<string>requiredOption roots included.sessionstringrequiredSession valued.rthgthcurballtrading_datestringdaterequiredTrading date valued.underlying_pricenumber | nullrequiredUnderlying price of the valuation.underlying_symbolstringrequiredThe requested underlying.unitstringrequiredScale of the values.per_percentper_dollarrawunit_labelsobjectrequiredWhat one unit is for each measure.2 fields insidedeltastringrequiredDelta exposure.gammastringrequiredGamma exposure.
valuationobjectrequiredWhat the snapshot was valued on.7 fields insidechain_timestampinteger | nullunix-msrequiredTime of the option chain the valuation used. Unix epoch milliseconds (UTC).open_interest_datestring | nulldaterequiredDate of the open interest the positioning is based on.risk_free_ratenumber | nullrequiredContinuously compounded risk-free rate used.timestampinteger | nullunix-msrequiredValuation time. Unix epoch milliseconds (UTC).underlying_pricenumber | nullrequiredUnderlying price used.underlying_stalebooleanrequiredThe underlying price is older than the freshness limit.underlying_timestampinteger | nullunix-msrequiredTime of the underlying price. Unix epoch milliseconds (UTC).
metaobjectrequiredMeta object
Example response
{
"data": {
"cells": [
{
"delta_exposure": 8100000000,
"gamma_exposure": 3400000000,
"spot_move_percent": -1,
"underlying_price": 5961.19,
"vol_move_points": 0
},
{
"delta_exposure": 11000000000,
"gamma_exposure": 2700000000,
"spot_move_percent": 0,
"underlying_price": 6021.4,
"vol_move_points": 0
}
],
"model": "classic_oi",
"perspective": "dealer",
"positioning_model": "oi_signed_proxy-v1",
"roots": [
"SPX",
"SPXW"
],
"session": "rth",
"trading_date": "2026-10-16",
"underlying_price": 6021.4,
"underlying_symbol": "SPX",
"unit": "per_percent",
"unit_labels": {
"delta": "usd_per_pct",
"gamma": "usd_per_pct"
},
"valuation": {
"chain_timestamp": 1792160995000,
"open_interest_date": "2026-10-15",
"risk_free_rate": 0.0412,
"timestamp": 1792161000000,
"underlying_price": 6021.4,
"underlying_stale": false,
"underlying_timestamp": 1792160999000
}
},
"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.
