Query Broker Trading Stats

for Primary key to retrieve overall trading volumes of the Broker user

Permission

  • Primary API Key: READ, retrieve overall trading volumes of the Broker user **
  • Sub-Portfolio API Key: Not Supported

Rate Limit

  • 20 requests per 1 seconds


Request

NameTypeMandatoryDescription
symStringNTrading pair unique identifier ,
example: BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT
businessTypeStringNbusinessType: SPOT, PERP
beginStringYStart time, in milliseconds timestamp format (utc 0:00), up to 90 days ago. Will be converted to 0am of the Date
endStringYEnd time, in milliseconds timestamp format (utc 0:00), Will be converted to 0am of the Date

Response

FieldTypeRemark
beginStringDate of StartTime
endStringDate of EndTime
allSpotStringTotal spot trading amount(USDT Volume)
allPerpStringTotal perp trading amount(USDT Volume)
detailsObjectList of trading amount detail
exchangeStringexchange: BINANCE, OKX
businessTypeStringBusinessType
executedAmountStringTrading amount(USDT Volume)

Note:

the parameters begin and end only extract the year, month, and day from the timestamp.
For example: If the timestamp for begin corresponds to 2025-12-23 10:30:00(UTC), and the timestamp for end corresponds to 2025-12-24 08:00:00(UTC),
then the final statistics will cover the data for the two days: 2025-12-23 to 2025-12-24.

Language