Get Trading Asset Distribution

Returns Trading currency distribution across DMA accounts or RapidX Portfolios.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the detailed Trading Asset View: each returned currency is broken down across accessible DMA accounts or RapidX Portfolios, and then into the relevant wallet or venue detail.

Use this endpoint when a user needs to reconcile or display where a Trading currency is held. It is the allocation counterpart to Get Trading Asset Summary, which returns only one aggregate row per currency.

Rate limit: 10 requests per minute per API key.

API key access

This is a read-only LTP Open API endpoint. READ permission is sufficient; TRADE, TRANSFER and WITHDRAW are not required.

API key typeCan callReturned Trading scope
Main User Level API keyYesCurrency allocation across DMA accounts and RapidX Portfolios accessible under the main user.
Sub-user Level API keyYesCurrency allocation across only the DMA accounts and RapidX Sub Portfolios assigned to that Sub-user.
Portfolio Level API key (a dedicated RapidX Sub Portfolio key)NoThis user-level asset service does not support Portfolio-scoped API keys.
Exchange-native API keyNoThis endpoint accepts signed LTP Open API keys only.

An unsupported API key level is rejected before asset data is read, normally with 2003. The required primeType selects the account family within the caller's permitted scope; it never expands that scope.

The literal word currency in the endpoint path is part of the route name, not a path parameter. Use the currency query parameter when filtering a currency symbol.

Query parameters

NameTypeRequiredDescription
primeTypestringYesAccount family to distribute: DMA or RAPIDX. Input is case-insensitive. It is required because the response hierarchy and account semantics differ between the two families.
currencystringNoOptional exact currency-symbol filter, such as USDT. Omit it to return every currency in the selected account family.
quoteCurrencystringNoCurrency used to value all returned currency, account and detail rows. Accepts USD, BTC or USDT; defaults to USD.
hideDustbooleanNoDefaults to true. It can remove low-value detail rows while retaining a currency or account aggregate. Therefore details can legitimately be an empty array; do not treat it as an error.
pageintegerNoOne-based page number for the outer currency list. Defaults to 1. Values less than or equal to zero use the default; a non-integer returns 1000.
pageSizeintegerNoMaximum currencies per page. Defaults to 20; values less than or equal to zero use the default; maximum is 1000. A value above 1000 returns 100400; a non-integer returns 1000.

Response structure

data has page, pageSize, totalSize and list. Pagination applies to the outer currency list only. Amounts are decimal strings; identifiers are opaque strings. The hierarchy is:

currency (data.list[])
  └── account or Portfolio (list[])
        └── wallet or venue detail (details[])

Top-level response fields

FieldTypeDescription
codeintegerApplication result code. 200 means success.
messagestringResult message.
data.pageintegerPage number used for the outer currency list.
data.pageSizeintegerPage size used for the outer currency list.
data.totalSizeintegerCount of matching currency rows. When the requested page is beyond the available range, this endpoint returns 0 together with an empty list.
data.listarrayCurrent page of currency distribution rows. An out-of-range page returns [] and totalSize = 0.

Currency level

Each data.list[] item is the aggregate of one currency across the selected primeType.

FieldTypeDescription
currencystringLTP currency symbol.
currencyDetailsobjectCurrency reference metadata. See Currency metadata below.
totalValuestringValue of this aggregate currency in quoteCurrency.
quoteCurrencystringValuation currency for this currency row.
exchangeRatestringUSD value of one unit of quoteCurrency; "1" for USD.
updatedAtintegerCurrency snapshot time as a Unix timestamp in milliseconds.
equitystringAggregate equity. This field appears only at the currency level.
balancestringAggregate balance across all nested account rows.
availablestringAggregate currently available amount.
frozenstringAggregate amount reserved or temporarily unavailable.
borrowedstringAggregate borrowed amount when applicable.
unrealizedPnlstringAggregate unrealized profit and loss when applicable.
intereststringAggregate accrued interest when applicable.
listarrayAccount/Portfolio allocation rows for this one currency.

Account or Portfolio level

Each nested list[] entry allocates the top-level currency to one account/Portfolio.

FieldTypeDescription
idstringOpaque DMA account ID or RapidX Portfolio ID.
primeTypestringdma or rapidx.
venuestringDMA exchange venue, for example BINANCE. It is empty at this layer for RapidX.
accountNotestringDMA account note or RapidX Portfolio note; empty string when unset.
accountNamestringRapidX Portfolio name; empty string for DMA.
totalValuestringValue of this currency in the one account/Portfolio.
balancestringBalance of this currency in the account/Portfolio.
availablestringCurrently available amount.
frozenstringReserved or unavailable amount.
borrowedstringBorrowed amount when applicable.
unrealizedPnlstringUnrealized profit and loss when applicable.
intereststringAccrued interest when applicable.
detailsarrayWallet/venue detail rows. It can be empty when hideDust hides the lower-level rows.

Wallet or venue detail

Each details[] item contains only the fields below. Account identity, name and note are provided by the parent account/Portfolio row.

FieldTypeDescription
accountTypestringFor DMA, the wallet type, such as SPOT or FUNDING. For RapidX, the exchange: BINANCE, OKX or EDX.
totalValuestringValue of this currency in the wallet or exchange, in the currency row's quoteCurrency.
balancestringBalance in this wallet or exchange.
availablestringAmount currently available in this wallet or exchange.
frozenstringReserved or temporarily unavailable amount.
borrowedstringBorrowed amount, when applicable.
unrealizedPnlstringUnrealized profit and loss, when applicable.
intereststringAccrued interest, when applicable.

equity appears only at the currency level. The detail rows do not repeat id, primeType, venue, accountName or accountNote.

Currency metadata

Field in currencyDetailsTypeDescription
idintegerCurrency identifier in the LTP reference catalogue.
iconUrlstringCurrency icon URL.
currencyNamestringFull display name of the currency.
slugstringCurrency slug.
referenceAssetIdintegerIdentifier of the reference asset associated with this currency; 0 if not configured.
multiplierintegerConversion multiplier between this currency and its reference asset; 0 if not configured.

Important interpretation rules

  • The account-level and detail-level rows are drill-downs of the top-level currency. Never add all three hierarchy levels together.
  • For DMA, the account layer identifies an exchange and the final layer identifies a wallet. For RapidX, the Portfolio layer has no single venue and the final layer identifies the exchange.
  • A successful result can contain a currency row with details = [] when dust filtering removes the detail rows. This is not a missing-data error.
  • Use this endpoint for currency allocation. Use the Trading Account List or Trading Account Assets endpoint for an individual account total.

Related RapidX API

For RapidX-specific margin and maximum transferable amount fields, see Get All Portfolio Assets. That endpoint provides additional RapidX detail and remains supported alongside Account Assets V2. It currently requires a Main User Level (main Portfolio) API key; check its permissions and rate limit before use.

Relevant errors

CodeWhen it occursWhat to do
1001Required primeType is missing.Send DMA or RAPIDX.
1000page or pageSize cannot be parsed as an integer.Send integer query values.
100400pageSize is above 1000.Use a page size from 1 to 1000.
404001quoteCurrency is not supported.Use USD, BTC or USDT.
404002primeType is invalid.Use DMA or RAPIDX.
100429The API key exceeds the rate limit.Back off before retrying.
Query Params
string
enum
required

Required account-family filter: DMA or RAPIDX. Input is case-insensitive; response primeType values are lowercase.

Allowed:
string

Currency symbol filter. Omit to return all currencies.

string
enum

Valuation currency. Defaults to USD.

Allowed:
boolean

Whether to hide assets valued below 1 USD. Defaults to true where supported.

integer
Defaults to 1

One-based page number; defaults to 1. Zero and negative values use the default. A non-integer returns 1000.

integer
Defaults to 20

Defaults to 20. Zero and negative values use the default; values above 1000 return 100400. A non-integer returns 1000.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json