Returns Trading assets aggregated by currency.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the Trading Asset View summary: one aggregate row per currency across all accessible DMA exchange sub-accounts and RapidX Portfolios.
Use it to answer “which currencies do I hold in Trading, and what is the combined amount/value?” It intentionally does not state which individual account, wallet or venue holds each portion. Use Get Trading Asset Distribution when the allocation is required.
Rate limit: 10 requests per minute per API key. This endpoint is not paginated.
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 type | Can call | Returned Trading scope |
|---|---|---|
| Main User Level API key | Yes | Currency totals across DMA accounts and RapidX Portfolios accessible under the main user. |
| Sub-user Level API key | Yes | Currency totals across only the DMA accounts and RapidX Sub Portfolios assigned to that Sub-user. |
| Portfolio Level API key (a dedicated RapidX Sub Portfolio key) | No | This user-level asset service does not support Portfolio-scoped API keys. |
| Exchange-native API key | No | This endpoint accepts signed LTP Open API keys only. |
An unsupported API key level is rejected before asset data is read, normally with 2003. A User Level key with no matching Trading assets receives a successful empty result.
Scope
The endpoint aggregates exactly the Trading objects accessible to the API key after applying the optional primeType filter. It does not include Funding, DeFi or Earn assets, and it has no network/chain allocation.
All values are decimal strings. Each currency row aggregates the selected Trading account scope.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
quoteCurrency | string | No | Currency used to value every aggregate row. Accepts USD, BTC or USDT; defaults to USD. It does not change balance quantities. |
primeType | string | No | Optional Trading-family filter: DMA or RAPIDX. Input is case-insensitive. Omit it to aggregate both account families. |
hideDust | boolean | No | Defaults to true. When true, currencies valued below 1 USD are omitted. Set false for a reconciliation that must include low-value currencies. |
currency | string | No | Optional exact currency-symbol filter. Omit it to return all Trading currencies in scope. A non-matching symbol succeeds with an empty list. |
Response fields
data contains totalValue, quoteCurrency, exchangeRate, updatedAt and list.
| Field | Type | Description |
|---|---|---|
code | integer | Application result code. 200 means success. |
message | string | Result message. |
data.totalValue | string | Total valuation of the returned Trading currency rows in data.quoteCurrency. |
data.quoteCurrency | string | Valuation currency used in the payload. |
data.exchangeRate | string | USD value of one unit of data.quoteCurrency; "1" for USD. |
data.updatedAt | integer | Asset snapshot time as a Unix timestamp in milliseconds. |
data.list | array | Currency-level aggregate rows. It is empty when no currency matches the scope and filters. |
Field in data.list[] | Type | Description |
|---|---|---|
currency | string | LTP currency symbol. |
currencyDetails | object | Currency reference metadata. See Currency metadata below. |
totalValue | string | Value of this aggregated currency in quoteCurrency. |
equity | string | Aggregate Trading equity for this currency. |
balance | string | Aggregate balance for this currency across the selected Trading accounts. |
available | string | Sum of quantities available for operations within the underlying accounts, in units of the currency. It does not necessarily equal the total transferable or withdrawable quantity. |
frozen | string | Aggregate amount temporarily reserved or unavailable. |
borrowed | string | Aggregate borrowed amount when applicable. |
unrealizedPnl | string | Aggregate unrealized profit and loss when applicable. |
interest | string | Aggregate accrued interest when applicable. |
Currency metadata
Field in currencyDetails | Type | Description |
|---|---|---|
id | integer | Currency identifier in the LTP reference catalogue. |
iconUrl | string | Currency icon URL. |
currencyName | string | Full display name of the currency. |
slug | string | Currency slug. |
referenceAssetId | integer | Identifier of the reference asset associated with this currency; 0 if not configured. |
multiplier | integer | Conversion multiplier between this currency and its reference asset; 0 if not configured. |
Choosing the correct Trading view
| Need | Endpoint |
|---|---|
| List accounts/Portfolios and their values | Get Trading Account List |
| Inspect one account/Portfolio | Get Trading Account Assets |
| See one aggregate row per currency | This endpoint |
| See the account/venue allocation of each currency | Get Trading Asset Distribution |
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
maxTransferablefrom 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
| Code | When it occurs | What to do |
|---|---|---|
404001 | quoteCurrency is not supported. | Use USD, BTC or USDT. |
404002 | primeType is not DMA or RAPIDX. | Use one supported value or omit the filter. |
100429 | The API key exceeds the rate limit. | Back off before retrying. |