Skip to content

Options · Order flow

Options flow tide

Net call and put premium across a basket of up to ten underlyings per bucket, with running totals.
On this page

The customer net premium (ask side minus bid side) of calls and of puts summed across a basket of underlyings, per bucket and accumulated from the start: net_premium is net call premium minus net put premium (positive when buying calls and selling puts dominates), net_volume the same in contracts. The basket is two to ten underlyings you list or a named basket. Mid-market and unknown-direction prints are excluded. Buckets that have not started yet are not returned.

Example request

curl -sS --get "https://api.ordermap.si/v1/options/flow/tide" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY" \
  --data-urlencode underlying_symbols=SPXW,SPY

Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.

Parameters

26 parameters, none required.

ParameterType and limitsDescription
underlying_symbolsqueryoptionalarray<string>comma-separated in one parameter1 to 10 itemseach at most 128 characterspattern ^[A-Za-z][A-Za-z0-9.]{0,7}$Two to ten underlyings, comma separated (for example SPX,SPY,QQQ). Use either underlying_symbols or basket.
basketqueryoptionalstringindexmegacapA named basket: index (SPX, SPY, QQQ, NDX, IWM, RUT, XSP, DIA; the default) or megacap (AAPL, MSFT, NVDA, TSLA, AMZN, META, GOOGL, AMD, NFLX, AVGO).
intervalqueryoptionalstring1m5m15m30m1hdefault 5mBucket length: 1m, 5m, 15m, 30m or 1h.
datequeryoptionalstringdateTrading date (YYYY-MM-DD). Default: the current session, else the most recent completed one. Overnight prints belong to the next trading date.
sessionqueryoptionalstringrthgthalldefault rthTrading 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_timequeryoptionalintegerunix-msmin 946684800000max 4102444800000Start of the window (inclusive). The window must lie within one trading session; combine with date to name that session.
end_timequeryoptionalintegerunix-msmin 946684800000max 4102444800000End of the window (exclusive).
contract_typequeryoptionalstringcallputCalls or puts. Omit for both.
date_of_expiryqueryoptionalstringdateOnly contracts expiring on this date.
min_dtequeryoptionalintegermin 0max 3650Minimum days to expiration (0 = expires on the trading date).
max_dtequeryoptionalintegermin 0max 3650Maximum days to expiration.
min_premiumqueryoptionalnumbermin 0max 1000000000000Minimum premium in US dollars of a print (price x size x multiplier).
max_premiumqueryoptionalnumbermin 0max 1000000000000Maximum premium in US dollars of a print.
min_sizequeryoptionalintegermin 1max 1000000000Minimum print size in contracts.
max_sizequeryoptionalintegermin 1max 1000000000Maximum print size in contracts.
trade_typequeryoptionalarray<string>comma-separated in one parametersweepblocksplitsinglegoldenmultilegcrossfloorauctioniso1 to 10 itemsComma-separated order types: sweep, block, split, single, golden, multileg, cross, floor, auction, iso. A print matches when any listed type applies. Sweeps and splits are inferred groupings, not exchange-confirmed.
sidequeryoptionalarray<string>comma-separated in one parameterabove_askat_asknear_askaskmidnear_bidat_bidbidbelow_bidunknown1 to 10 itemsComma-separated aggressor classes: above_ask, at_ask, near_ask, mid, near_bid, at_bid, below_bid, unknown. ask selects at_ask and near_ask, bid selects near_bid and at_bid. at_ask without near_ask (and at_bid without near_bid) can be asked for only on /v1/options/trades and /v1/options/flow/overnight; elsewhere use ask and bid.
sentimentqueryoptionalarray<string>comma-separated in one parameterbullishbearishneutralunknown1 to 4 itemsComma-separated sentiments: bullish (calls bought or puts sold), bearish (puts bought or calls sold), neutral (traded at the mid) and unknown (direction not determinable).
otm_onlyqueryoptionalbooleanOnly out-of-the-money contracts (strike beyond the underlying price). Prints without a known underlying price are excluded.
min_otm_pctqueryoptionalnumbermin -100max 1000Only contracts at least this far out of the money, in percent of the underlying price (calls (strike - price) / price, puts (price - strike) / price; negative reaches into the money). With otm_only the larger minimum holds.
max_otm_pctqueryoptionalnumbermin -100max 1000Only contracts at most this far out of the money, in percent of the underlying price.
moneynessqueryoptionalstringitmatmotmOnly contracts in this moneyness class when the print traded: itm (in the money), atm (at the money) or otm (out of the money).
opening_onlyqueryoptionalbooleanOnly prints that probably open a position: the day's volume or the print's size exceeds the contract's open interest. Combined with unusual_only, both must hold.
include_complexqueryoptionalbooleanInclude multi-leg (complex order) prints. Default false.
min_strikequeryoptionalnumber> 0max 1000000Lowest strike in dollars.
max_strikequeryoptionalnumber> 0max 1000000Highest strike in dollars.

Response

StatusMeaningBody
200Successful response.Schema below
400Invalid, unknown or repeated parameters, or an invalid cursor.Error object
401Missing or invalid API key.Error object
403The plan, dataset release or account state does not allow this request.Error object
422The request is valid but no data exists for it.Error object
429Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-AfterError object
500Internal error.Error object
503Data temporarily unavailable; retry after Retry-After seconds.Retry-AfterError object
504The 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>required9 fields inside
    • bucket_timeintegerunix-msrequiredStart of the bucket. Unix epoch milliseconds (UTC).
    • cumulative_net_call_premiumnumber | nullrequirednet_call_premium accumulated from the first bucket.
    • cumulative_net_premiumnumber | nullrequirednet_premium accumulated from the first bucket.
    • cumulative_net_put_premiumnumber | nullrequirednet_put_premium accumulated from the first bucket.
    • cumulative_net_volumenumber | nullrequirednet_volume accumulated from the first bucket.
    • net_call_premiumnumber | nullrequiredNet call premium (ask side minus bid side) in US dollars.
    • net_premiumnumber | nullrequirednet_call_premium minus net_put_premium.
    • net_put_premiumnumber | nullrequiredNet put premium in US dollars.
    • net_volumenumber | nullrequiredNet call contracts minus net put contracts.
  • metaobjectrequiredMeta object

Example response

{
  "data": [
    {
      "bucket_time": 1792161000000,
      "cumulative_net_call_premium": 18400000,
      "cumulative_net_premium": 9300000,
      "cumulative_net_put_premium": 9100000,
      "cumulative_net_volume": 21000,
      "net_call_premium": 18400000,
      "net_premium": 9300000,
      "net_put_premium": 9100000,
      "net_volume": 21000
    }
  ],
  "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.