Skip to content

Futures · Order book

Futures book imbalance

Bid and ask imbalance of the displayed futures book over several depths, with the microprice.
GET/v1/futures/book/imbalancefuturesBookImbalance
On this page

For each requested depth (default 1, 5, 10 and 20 levels per side) the displayed size and orders on each side and imbalance = (bid size - ask size) / (bid size + ask size), between -1 and 1. mid is the midpoint of the best bid and ask, spread_ticks the spread in ticks and microprice = (best bid x ask size + best ask x bid size) / (bid size + ask size) at the touch. Only the live book exists. Every figure is null when the book is not synchronized; when a side is empty its size and orders, the imbalance and the microprice are null; coverage.complete is then false. A depth given twice is measured once. The figures describe displayed anonymous size only; they do not infer hidden orders.

Example request

curl -sS --get "https://api.ordermap.si/v1/futures/book/imbalance" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY" \
  --data-urlencode symbol=ES

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

Parameters

3 parameters, none required.

ParameterType and limitsDescription
symbolqueryoptionalstringat most 3 characterspattern ^[A-Za-z0-9]{1,3}$Futures product root, for example ES, NQ, CL or GC. Without contract the current front month is used and returned in the response.
contractqueryoptionalstringat most 6 characterspattern ^[A-Za-z0-9]{1,3}[FGHJKMNQUVXZfghjkmnquvxz][0-9]{1,2}$Exact dated contract: root, month code and year, for example ESZ6 (December 2026). Two-digit years are accepted and returned in the one-digit form (ESZ26 is ESZ6). Only the front month and the contracts listed by /v1/futures/contracts are served.
levelsqueryoptionalarray<integer>comma-separated in one parameter1 to 6 itemsDepths, in levels per side, to measure; at most 6 values from 1 to 100. Default 1,5,10,20.

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

  • dataobjectrequiredBook imbalance of one contract.14 fields inside
    • contractstringrequiredDated contract.
    • deptharray<object>requiredOne entry per requested depth, shallowest first.6 fields inside
      • ask_ordersinteger | nullrequiredDisplayed ask orders over those levels.
      • ask_sizeinteger | nullrequiredDisplayed ask contracts over those levels.
      • bid_ordersinteger | nullrequiredDisplayed bid orders over those levels.
      • bid_sizeinteger | nullrequiredDisplayed bid contracts over those levels.
      • imbalancenumber | nullrequired(bid size - ask size) / (bid size + ask size), from -1 to 1.
      • levelsintegerrequiredLevels per side.
    • micropricenumber | nullrequiredSize-weighted price at the touch: pulled toward the thinner side.
    • midnumber | nullrequiredMidpoint of the best bid and ask.
    • spread_ticksinteger | nullrequiredSpread in ticks.
    • symbolstringrequiredProduct root.
    • timestampinteger | nullunix-msrequiredTime of the book. Unix epoch milliseconds (UTC).
    • validbooleanrequiredThe book is synchronized; a false book has no figures.
  • metaobjectrequiredMeta object

Example response

{
  "data": {
    "contract": "ESZ6",
    "depth": [
      {
        "ask_orders": 24,
        "ask_size": 96,
        "bid_orders": 31,
        "bid_size": 118,
        "imbalance": 0.1028,
        "levels": 1
      }
    ],
    "microprice": 6021.3879,
    "mid": 6021.375,
    "spread_ticks": 1,
    "symbol": "ES",
    "timestamp": 1792159200123,
    "valid": true
  },
  "meta": {
    "as_of": 1760659200123,
    "coverage": {
      "complete": true
    },
    "delay_ms": 0,
    "delayed": false,
    "request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
    "source": "cme"
  }
}

Values are illustrative. Missing values are null, never 0.