Get Trading Account Assets

Returns the asset detail for one DMA account or RapidX Portfolio.

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

Returns the asset detail for one Trading object selected from Get Trading Account List. The selected id can identify either a DMA exchange sub-account or a RapidX Portfolio.

This is an Account View drill-down. It first divides the selected object into account slices and then lists currencies held inside each slice. Trading data does not include a network/chain dimension.

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 callPermitted id
Main User Level API keyYesA DMA account or RapidX Portfolio accessible under the main user.
Sub-user Level API keyYesOnly a DMA account or RapidX Sub Portfolio 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.

For a valid User Level key, a missing, malformed, inaccessible or non-existent id intentionally returns the same 404004 result. An unsupported API key level is rejected earlier, normally with 2003.

How the two levels differ

The meaning of accountType depends on primeType:

primeTypeOuter accountType representsExamples
dmaA wallet or account type inside one DMA exchange sub-accountSPOT, FUNDING, MARGIN_CROSS
rapidxAn exchange venue inside one RapidX PortfolioBINANCE, OKX, EDX

Use the outer list to show wallet/venue subtotals and the nested currency list to show holdings within each wallet or venue.

Path and query parameters

NameTypeRequiredDescription
idstringYesDMA account ID or RapidX Portfolio ID taken from the Trading Account List. Treat it as an opaque string; it is not interchangeable with a user ID.
quoteCurrencystringNoCurrency used to value the selected account and all slices within it. Accepts USD, BTC or USDT; defaults to USD.
accountTypestringNoOptional one-slice filter. For DMA, provide a wallet type such as SPOT; for RapidX, provide a venue such as BINANCE. Omit it to return every slice.
currencystringNoOptional currency-symbol filter. Omit it to return all currencies in every returned slice.
hideDustbooleanNoDefaults to true. When true, currencies valued below 1 USD are hidden. Set false for a reconciliation that must include low-value holdings.

Response fields

data contains id, totalValue, quoteCurrency, exchangeRate, updatedAt and list. All amounts are decimal strings, and all identifiers must be preserved as strings.

FieldTypeDescription
codeintegerApplication result code. 200 means success.
messagestringResult message.
data.idstringThe requested account/Portfolio identifier.
data.totalValuestringValue of the selected account/Portfolio in data.quoteCurrency.
data.quoteCurrencystringValuation currency used in the entire payload.
data.exchangeRatestringUSD value of one unit of data.quoteCurrency; "1" for USD.
data.updatedAtintegerAsset snapshot time as a Unix timestamp in milliseconds.
data.listarrayOuter wallet/venue slices. An empty array is a successful result when the account has no matching asset rows.

Each outer data.list[] item is an account slice:

FieldTypeDescription
accountTypestringDMA wallet type or RapidX venue, as described above. This is the dimension that separates outer slices.
totalValuestringValuation of the one wallet/venue slice in quoteCurrency.
primeTypestringAccount family: dma or rapidx.
quoteCurrencystringValuation currency for this slice.
idstringID of the selected DMA account or RapidX Portfolio.
venuestringExchange venue. For DMA, this identifies the exchange containing the wallet. For RapidX, it equals accountType: BINANCE, OKX or EDX.
accountModestringDMA account mode when supplied; normally empty for RapidX.
accountNotestringDMA account note or RapidX Portfolio note. Empty string when no note is set.
accountNamestringRapidX Portfolio name. Empty string for DMA, where no account name is exposed.
uidstringUID of the user to whom the DMA sub-account or RapidX Sub Portfolio is assigned. If assigned to a Sub-user, returns that Sub-user's UID; otherwise returns the main user's UID. This reflects the account assignment, not the API caller.
ownerPrimaryUserUidstringAlways the main user's UID, regardless of whether the account or Sub Portfolio is assigned to a Sub-user.
statusstringDMA: ACTIVE or FROZEN. RapidX Portfolio: ACTIVE, FROZEN or UNAVAILABLE.
portfolioTypestringRapidX Portfolio: MAIN or SUB. Empty string for DMA.
isLendingPortfoliobooleanWhether a RapidX Portfolio is marked as a lending Portfolio.
isMarginxGroupMemberbooleanWhether the DMA account or RapidX Portfolio is a MarginX Group member.
isMirroredAccountbooleanWhether the account is marked as mirrored.
isTradeOnlybooleanWhether the account is marked as trade-only.
isExternalbooleanWhether the account is marked as external.
listarrayCurrency holdings inside this particular wallet/venue slice.

Each nested currency item contains:

FieldTypeDescription
currencystringLTP currency symbol.
currencyDetailsobjectCurrency reference metadata. See Currency metadata below.
equitystringTrading equity for this currency in this slice.
balancestringCurrency balance in this slice.
availablestringQuantity available for operations within the current account, in units of the currency. It does not necessarily equal the transferable or withdrawable quantity.
frozenstringAmount temporarily reserved, for example by an order or other hold.
borrowedstringBorrowed amount for this currency when applicable.
unrealizedPnlstringUnrealized profit and loss for this currency when applicable.
intereststringAccrued interest for this currency when applicable.

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.

Interpretation notes

  • available describes account-internal usability; it should not be assumed to equal the maximum transfer or withdrawal amount.
  • DMA wallet types vary by venue and account configuration.
  • A missing, inaccessible or unowned account returns the same error code.

Available versus transferable amounts

available is the quantity usable for operations within the current account, such as placing spot orders. It does not necessarily equal the quantity that can be transferred out or withdrawn. The quantities may be equal in Funding, spot or unified accounts. For example, a unified account without open positions, open orders or other collateral requirements may have equal available and transferable quantities. Positions, open orders and collateral requirements can cause them to differ; the account mode alone does not determine whether they are equal. Aggregated available should not be assumed to equal the total transferable amount.

  • DMA sub-accounts: query the exchange's native API for the transferable amount of the relevant asset and wallet, particularly for portfolio-margin and multi-currency margin accounts.
  • RapidX Portfolios: use maxTransferable from Get Portfolio Asset Details, matching the asset and exchange. The API key selects the Portfolio: a Main User Level key queries the Main Portfolio; a dedicated Sub Portfolio key queries its own Portfolio. Sub-user Level keys cannot call that endpoint.

Get All Portfolio Assets also returns maxTransferable for a cross-Portfolio view and requires a Main User Level API key. These RapidX endpoints remain supported alongside Account Assets V2.

The transferable amount is determined at query time; the transfer request is checked again when processed.

Relevant errors

CodeWhen it occursWhat to do
404001quoteCurrency is not supported.Use USD, BTC or USDT.
404004The id is missing, malformed, does not exist, or is not accessible to this API key.Use an id returned by the caller's Trading Account List. These cases intentionally share one code, so do not attempt to infer which one applies.
100429The API key exceeds the rate limit.Back off before retrying.
Path Params
string
required

DMA account ID or RapidX Portfolio ID.

Query Params
string
enum

Valuation currency. Defaults to USD.

Allowed:
string

DMA wallet type or RapidX venue filter.

string

Currency symbol filter. Omit to return all currencies.

boolean

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

Response

Language
LoadingLoading…
Response
Choose an example:
application/json