Query User Trading Volume

Description

This endpoint returns user-level trading volume statistics for a specified time range.

The returned trading volume is aggregated across the entire user portfolios, including:

  • Main Portfolio
  • All Sub Portfolios

The trading volume data is updated once per day and calculated on a natural-day basis (00:00–00:00).

Time Range Rules (Important)

The begin and end parameters must be provided as Unix timestamps in milliseconds (ms).

To ensure consistent daily aggregation:

  • If begin is not at 00:00:00, it will be automatically rounded down to 00:00:00 of that day.
  • If end is not at 00:00:00, it will be automatically aligned to the daily boundary (natural-day cutoff at 00:00:00).

The response fields begin and end are returned in yyyyMMdd format and reflect the aligned date range used for calculation.

Permission

  • Access to this endpoint requires a Main Portfolio API key with READ permission.
  • API keys created under Sub Portfolios are not eligible to query this endpoint at this time.

Rate Limit

20 requests per 1 second.

Request

FieldTypeMandatoryDescription
exchangeStringNExchange filter. Supported values: BINANCE, OKX, EDX
businessTypeStringNBusiness type filter. Supported values: SPOT, PERP
beginStringYStart date/time (automatically aligned to 00:00:00 of that day)
endStringYEnd date/time (automatically aligned to daily boundary)

Response

FieldTypeRemark
beginStringStart date/time (automatically aligned to 00:00:00 of that day)
endStringEnd date/time (automatically aligned to daily boundary)
allSpotStringTotal spot trading volume in USDT
allPerpStringTotal perp trading volume in USDT
detailsObjectList of trading amount detail
exchangeStringBINANCE, OKX, EDX
businessTypeStringSPOT, PERP. MARGIN Trading Volume is included in the SPOT Volume
executedAmountStringTrading amount in USDT
Language
Credentials
OAuth2