Options · Exposure
Options exposure hedge estimate
/v1/options/exposure/hedge-estimateoptionsExposureHedgeEstimateThe modeled net dealer delta in shares and, for each move of the underlying, the shares dealers would trade to stay delta neutral: the difference between their modeled delta at the current price and at the moved price, read from the delta profile repriced over a sweep of underlying prices (sticky-strike volatility), interpolated linearly. Hedging figures are the shares dealers would trade to stay delta neutral against the modeled change of their delta: positive means dealers buy, negative means they sell. A move outside the 20% sweep is refused. A model, not an observation. 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/exposure/hedge-estimate" \
-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/hedge-estimate?${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
12 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. |
modelqueryoptional | stringclassic_oiflow_adjusteddefault classic_oi | Dealer positioning model: classic_oi (open interest, calls long and puts short) or flow_adjusted (adjusted by classified prints since the open interest date). |
perspectivequeryoptional | stringdealercustomerdefault dealer | dealer (default) or customer, which negates the values only. |
movesqueryoptional | array<string>comma-separated in one parameter1 to 8 itemseach at most 128 characterspattern ^-?[0-9]+(\.[0-9]+)?$ | Moves of the underlying in percent, comma separated, at most 8, each between -19.9 and 19.9 (the priced sweep is plus or minus 20 percent, and a move at its edge can round outside it). Default: -2,-1,-0.5,0.5,1,2. |
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 hedging estimate.26 fields insidegreekstringrequiredThe measure: gamma, delta, vanna, charm, vega, theta, rho, vomma, veta, speed, zomma, color, ultima or the heat map metric.modelstringrequiredDealer positioning model.classic_oiflow_adjustedflow_onlynet_delta_sharesnumber | nullrequiredModeled net dealer delta in shares at the current price.perspectivestringrequireddealer 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.scenariosarray<object>requiredOne entry per requested move.5 fields insidedirectionstring | nullrequiredbuy or sell; null when no trade is needed or unknown.buysellnullhedge_notionalnumber | nullrequiredhedge_shares times the moved price, in dollars.hedge_sharesnumber | nullrequiredShares dealers trade to stay delta neutral; positive means buy.move_pctnumberrequiredMove of the underlying in percent.spot_thennumber | nullrequiredUnderlying price after the move.
sessionstringrequiredSession valued.rthgthcurballspotnumber | nullrequiredUnderlying price.trading_datestringdaterequiredTrading date valued.underlying_symbolstringrequiredThe requested underlying.unitstringrequiredScale of the values.per_percentper_dollarrawunit_labelstringrequiredWhat one unit is, for example usd_per_pct: dollars of dealer hedging per 1% move.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": {
"greek": "delta",
"model": "classic_oi",
"net_delta_shares": 1500000,
"perspective": "dealer",
"positioning_model": "oi_signed_proxy-v1",
"roots": [
"SPX",
"SPXW"
],
"scenarios": [
{
"direction": "buy",
"hedge_notional": 508326588,
"hedge_shares": 84000,
"move_pct": 0.5,
"spot_then": 6051.507
}
],
"session": "rth",
"spot": 6021.4,
"trading_date": "2026-10-16",
"underlying_symbol": "SPX",
"unit": "raw",
"unit_label": "shares",
"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.
