Query User's Portfolio Trading Volume

Description

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

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

The response includes:

Aggregated summary fields: Trading volume (USDT-denominated) grouped by exchange and business type, such as:

  • okxSpotVolUsd
  • okxPerpVolUsd
  • binanceSpotVolUsd
  • binancePerpVolUsd

Detailed breakdown (details): A granular list grouped by exchange + businessType + symbol, including:

  • executedAmount — Total executed trading volume (USDT)
  • totalTradingFee — Total accumulated trading fees
  • totalRpnl — Total realized PnL (Realized Profit & Loss)

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 or Sub Portfolio API key with READ permission.

Rate Limit

10 requests per 1 hour.

Request

FieldTypeMandatoryDescription
symListStringNTrading pair unique identifier. A maximum of 5 symbols can be specified in a single request.

If symList is provided, it overrides the businessType and exchange parameters, and those filters will not take effect.

Example: BINANCE_PERP_BTC_USDT, OKX_PERP_BTC_USDT
exchangeStringNExchange filter. Supported values: BINANCE, OKX
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

FieldTypeDescription
beginStringStart date/time (automatically aligned to 00:00:00 of that day)
endStringEnd date/time (automatically aligned to daily boundary)
okxSpotVolUsdStringOKX spot trading volume in USDT
okxPerpVolUsdStringOKX perp trading volume in USDT
binanceSpotVolUsdStringBinance spot trading volume in USDT
binancePerpVolUsdStringBinance perp trading volume in USDT
detailsObjectList of trading amount detail
> exchangeStringBINANCE, OKX, EDX
> businessTypeStringSPOT, PERP. MARGIN Trading volume is included in the SPOT Volume
> symbolStringTrading pair unique identifier.
> executedAmountStringTrading amount in USDT
> totalTradingFeeStringTotal trading fee in USDT.
> totalRpnlStringTotal realized PNL in USDT.
Language
Credentials
OAuth2