Options · Order flow
Options flow greek flow
/v1/options/flow/greek-flowoptionsFlowGreekFlowFor each bucket of the session, the Greek exposure of the option prints customers bought and sold, split into call buys, call sells, put buys and put sells, with the net and the cumulative net from the start of the session and the totals over the window. Delta is in dollars of underlying, gamma in dollars per 1% move, vega in dollars per volatility point, theta, in dollars per calendar day, vanna in dollars of delta per volatility point and charm in dollars of delta per day; unit_label names the unit. Buckets that have not started yet are not returned. The Greeks are model values computed by the platform for every directional, non-complex print from the print's own implied volatility, the underlying price and the time to expiration at the print, with zero interest rate and dividend yield (delta is the delta stored with the print); they are not exchange data. Values are signed by the customer: a purchase adds the contract's Greek and a sale subtracts it, so customers buying calls give positive delta, gamma and vega. A print without a stored implied volatility has no Greeks and is counted in missing_prints; a bucket holding only such prints is null, and when no print of the request has Greeks every value is null and meta.coverage.complete is false.
Example request
curl -sS --get "https://api.ordermap.si/v1/options/flow/greek-flow" \
-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/greek-flow?${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
7 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. |
greeksqueryoptional | array<string>comma-separated in one parameterdeltagammavegathetavannacharm1 to 6 items | The Greeks to return, in the order of the response: delta, gamma, vega, theta, vanna and charm. Default: all six. |
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
dataobjectrequiredGreek flow of customers.24 fields insidebucketsarray<object>requiredOne entry per bucket that has started.10 fields insidegreeksarray<object>requiredOne entry per requested Greek, in request order.7 fields insidecall_buynumber | nullrequiredCall purchases.call_sellnumber | nullrequiredCall sales.cumulativenumber | nullrequiredNet accumulated from the start of the session.greekstringrequiredThe Greek.netnumber | nullrequiredSum of the four.put_buynumber | nullrequiredPut purchases.put_sellnumber | nullrequiredPut sales.
missing_printsintegerrequiredDirectional prints of the bucket without Greeks; they are not in the values.timestampintegerunix-msrequiredStart of the bucket. Unix epoch milliseconds (UTC).
greeks_availablebooleanrequiredFalse when no print of the request carries Greeks; every value is then null.intervalstringrequiredBucket length.sessionstringrequiredSession.rthgthalltotalsarray<object>requiredTotals over the window, one entry per requested Greek.7 fields insidecall_buynumber | nullrequiredCall purchases.call_sellnumber | nullrequiredCall sales.greekstringrequiredThe Greek.netnumber | nullrequiredSum of the four.put_buynumber | nullrequiredPut purchases.put_sellnumber | nullrequiredPut sales.unit_labelstringrequiredWhat one unit is, for example usd_per_pct.
trading_datestringdaterequiredTrading date.underlying_symbolstringrequiredThe requested underlying.
metaobjectrequiredMeta object
Example response
{
"data": {
"buckets": [
{
"greeks": [
{
"call_buy": 2100000,
"call_sell": -1400000,
"cumulative": 900000,
"greek": "gamma",
"net": 900000,
"put_buy": 1000000,
"put_sell": -800000
}
],
"missing_prints": 0,
"timestamp": 1792161000000
}
],
"greeks_available": true,
"interval": "5m",
"session": "rth",
"totals": [
{
"call_buy": 81000000,
"call_sell": -60000000,
"greek": "gamma",
"net": 29000000,
"put_buy": 52000000,
"put_sell": -44000000,
"unit_label": "usd_per_pct"
}
],
"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.
