Stocks · Statistics
Stocks relative volume
/v1/stocks/relative-volumestocksRelativeVolumeShares traded in the current regular session (09:30 to 16:00 Eastern) up to the last completed five-minute bar (the bar that is forming is left out of both sides, and coverage.forming_bar_excluded says so), divided by the average of the same cumulative figure over the previous sessions at the same time of day. The current session is the latest one with trading. percentile_rank is the share of the previous sessions whose cumulative volume at that time was at or below today's, from 0 to 100. checkpoints repeat the comparison at every half hour up to now. Extended-hours volume is not counted. With fewer than three previous sessions the comparison is null. A session is the latest 5-minute read of the stock's consolidated volume. 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/stocks/relative-volume" \
-H "Authorization: Bearer $ORDERMAP_API_KEY" \
--data-urlencode symbol=AAPLconst params = new URLSearchParams({
symbol: "AAPL",
});
const res = await fetch(`https://api.ordermap.si/v1/stocks/relative-volume?${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
2 parameters, 1 required.
| Parameter | Type and limits | Description |
|---|---|---|
symbolqueryrequired | stringat most 11 characterspattern ^[A-Za-z]{1,6}(\.[A-Za-z0-9]{1,4})?$ | Ticker symbol, for example AAPL. |
sessionsqueryoptional | integerdefault 20min 5max 20 | Previous sessions in the average, 5 to 20. |
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
dataobjectrequiredRelative volume of one stock.13 fields insideaverage_cumulative_volumenumber | nullrequiredAverage of the previous sessions up to the same time of day.checkpointsarray<object>requiredThe comparison at every half hour of the session so far.4 fields insideaverage_cumulative_volumenumber | nullrequiredThe same for the average of the previous sessions.clock_etstringrequiredTime of day, HH:MM Eastern Time.cumulative_volumenumberrequiredShares traded in the current session from the open until then.relative_volumenumber | nullrequiredCurrent over average.
cumulative_volumenumber | nullrequiredShares traded in the current session up to timestamp.datestring | nulldaterequiredExchange date of the current session.percentile_ranknumber | nullrequiredShare of previous sessions at or below today's cumulative volume, 0 to 100.relative_volumenumber | nullrequiredcumulative_volume divided by average_cumulative_volume.sessions_usedintegerrequiredPrevious sessions in the average.symbolstringrequiredTicker symbol.timestampinteger | nullunix-msrequiredEnd of the last completed bar counted. Unix epoch milliseconds (UTC).
metaobjectrequiredMeta object
Example response
{
"data": {
"average_cumulative_volume": 7400000,
"checkpoints": [
{
"average_cumulative_volume": 7400000,
"clock_et": "10:00",
"cumulative_volume": 9800000,
"relative_volume": 1.3243
}
],
"cumulative_volume": 9800000,
"date": "2026-10-16",
"percentile_rank": 90,
"relative_volume": 1.3243,
"sessions_used": 20,
"symbol": "AAPL",
"timestamp": 1792159200000
},
"meta": {
"as_of": 1760659200123,
"coverage": {
"complete": true
},
"delay_ms": 0,
"delayed": false,
"request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
"source": "sip"
}
}Values are illustrative. Missing values are null, never 0.
