Skip to content

Futures · Statistics

Futures relative volume

Cumulative volume of the current futures session against the average of prior sessions at the same time of day.
GET/v1/futures/relative-volumefuturesRelativeVolume
On this page

The contracts traded since the session opened (18:00 Eastern Time) compared with the average cumulative volume of the previous sessions at the same offset from their open, from 30-minute bars: relative_volume is today's divided by the average, and curve repeats it at every completed 30-minute step since the open. The figures are taken at the last completed 30-minute step (elapsed_minutes is that offset), for today and for the prior sessions alike; the bar that is forming is left out of both and coverage.forming_bar_excluded says so. Only prior sessions that have bars count (coverage.sessions_used); the average is null with none. Reads the 30-minute bars of up to 10 prior sessions through a deferred history read, so a first request can answer 503 data_pending; retry. The figures use a longer lookback than the dated rows your plan's history window allows (the window limits the rows returned, not the lookback a statistic is computed from); this route returns no dated rows.

Example request

curl -sS --get "https://api.ordermap.si/v1/futures/relative-volume" \
  -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.
sessionsqueryoptionalintegerdefault 10min 3max 10Prior sessions to average.

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

  • dataobjectrequiredRelative volume of the current session.10 fields inside
    • average_cumulative_volumenumber | nullrequiredAverage of the prior sessions' cumulative volume at the same point.
    • contractstring | nullrequiredDated contract.
    • cumulative_volumeinteger | nullrequiredContracts traded from the open to the last completed 30-minute step; the bar that is forming is not counted.
    • curvearray<object>requiredThe same figures at every 30-minute step since the open.4 fields inside
      • average_cumulative_volumenumber | nullrequiredPrior sessions' average through the step.
      • cumulative_volumeinteger | nullrequiredContracts traded through the step.
      • offset_minutesintegerrequiredMinutes since the open.
      • relative_volumenumber | nullrequiredcumulative_volume divided by the average.
    • elapsed_minutesintegerrequiredMinutes from the open to the last completed 30-minute step, the point every figure is taken at.
    • relative_volumenumber | nullrequiredcumulative_volume divided by average_cumulative_volume.
  • metaobjectrequiredMeta object

Example response

{
  "data": {
    "average_cumulative_volume": 368120.5,
    "contract": "ESZ6",
    "cumulative_volume": 412837,
    "curve": [
      {
        "average_cumulative_volume": 19840.2,
        "cumulative_volume": 21030,
        "offset_minutes": 30,
        "relative_volume": 1.06
      }
    ],
    "elapsed_minutes": 540,
    "relative_volume": 1.12
  },
  "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.