Skip to main content
POST
Get per-user trade volume and broker fees, broken down by exchange, for a list of users

Headers

X-Broker-Key
string
required

Broker API key

Body

application/json
usersList
BrokerUserVolumeInput · object[]
required

Users to compute stats for (1-100).

Required array length: 1 - 100 elements
exchanges
enum<string>[]

Count trades only on these exchanges. When omitted, all supported exchanges are counted. Excluded exchanges are still present in the response with zero amounts.

Minimum array length: 1

Supported perpetual exchange

Available options:
aster,
binance,
bybit,
extended,
gate,
hyperliquid,
lighter,
mexc,
ondo,
robinhood
from
integer

Start of the period as unix timestamp in milliseconds (inclusive). Defaults to now - 30 days (1 day for hour resolution).

Required range: x <= 9007199254740991
Example:

1767225600000

resolution
enum<string>
default:day

Aggregation interval: day (UTC calendar day) or hour (UTC clock hour). from/to snap to interval boundaries. On series endpoints, items span one interval and hour limits the range to 7 days. Defaults to day.

Available options:
day,
hour
to
integer

End of the period as unix timestamp in milliseconds (inclusive). Defaults to now.

Required range: x <= 9007199254740991
Example:

1769903999000

Response

200 - application/json
exchanges
object
required

Per-exchange breakdown of volume and broker fees.

totalVolume
string
required

Total executed notional across all exchanges.

Example:

"103000.00"

userId
string<uuid>
required

User id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$