Get Trading Account List

Lists accessible DMA accounts and RapidX Portfolios.

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

Lists the Trading accounts accessible to the API key. A list item represents either a DMA exchange sub-account or a RapidX Portfolio. This is the Account View: it answers “which accounts can I see, and what is each account worth?”

It deliberately returns account-level valuation rather than currency holdings. Take an id from this list and call Get Trading Account Assets when the user opens an account and needs its wallet/venue and currency detail.

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 keyYesDMA accounts and RapidX Portfolios accessible under the main user.
Sub-user Level API keyYesOnly DMA accounts and RapidX Sub Portfolios assigned to that Sub-user.
Portfolio Level API key (a dedicated RapidX Sub Portfolio key)NoThis user-level list endpoint does not support Portfolio-scoped API keys.
Exchange-native API keyNoThis endpoint accepts signed LTP Open API keys only.

The main user cannot use this endpoint to impersonate a Sub-user; a Sub-user cannot use it to enumerate the main user's unassigned resources. An unsupported API key level is rejected before data is read, normally with 2003.

What is included

  • primeType = dma identifies a DMA exchange sub-account.
  • primeType = rapidx identifies a RapidX Portfolio.
  • The response contains only objects accessible to the API key. An empty list is a normal success response; it does not distinguish “no accounts” from “the selected filters matched none.”
  • Trading assets have no network/chain dimension in this API. Network-level data belongs to the Funding and DeFi asset views.

Query parameters

NameTypeRequiredDescription
quoteCurrencystringNoCurrency used to value the account totals. Accepts USD, BTC or USDT; defaults to USD. It does not change account balances.
primeTypestringNoOptional account-family filter: DMA or RAPIDX. Input is case-insensitive; returned values are lowercase. Omit it to return both families.
accountFilterstringNoOptional exact DMA account ID or RapidX Portfolio ID. It is a filter, not a resource lookup: an inaccessible or non-matching value succeeds with list = [].
hideDustbooleanNoDefaults to true. When true, account rows valued below 1 USD are hidden. Set false for a reconciliation that must include low-value accounts.
pageintegerNoOne-based page number. Defaults to 1. Values less than or equal to zero are treated as the default; a non-integer returns 1000.
pageSizeintegerNoMaximum items per page. Defaults to 20; values less than or equal to zero use the default; the maximum is 1000. A value above 1000 returns 100400; a non-integer returns 1000.

Response fields

data contains totalValue, quoteCurrency, exchangeRate, updatedAt, page, pageSize, totalSize and list. Monetary values and IDs are strings. Preserve numeric precision and treat IDs as opaque values.

FieldTypeDescription
codeintegerApplication result code. 200 means success.
messagestringResult message.
data.totalValuestringTotal valuation of the Trading accounts represented by this response, in data.quoteCurrency.
data.quoteCurrencystringValuation currency actually used in this response.
data.exchangeRatestringUSD value of one unit of data.quoteCurrency; "1" for USD.
data.updatedAtintegerAsset snapshot time as a Unix timestamp in milliseconds.
data.pageintegerPage number used to produce this list.
data.pageSizeintegerPage size used to produce this list.
data.totalSizeintegerTotal number of items matching the filters before page slicing.
data.listarrayCurrent page of account / Portfolio rows. A page beyond the available range succeeds with an empty array.
Field in data.list[]TypeDescription
primeTypestringAccount family: dma for a DMA exchange sub-account or rapidx for a RapidX Portfolio. Response values are lowercase.
idstringOpaque account identifier. It is a DMA account ID when primeType is dma and a RapidX Portfolio ID when it is rapidx. Pass it unchanged to the account-detail endpoint.
quoteCurrencystringCurrency used to value this account.
totalValuestringAccount/Portfolio value in quoteCurrency.
venuestringDMA exchange venue, for example BINANCE. It is an empty string for a RapidX Portfolio list row.
accountModestringDMA account mode, when supplied. It is an empty string 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 the 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 a mirrored account.
isTradeOnlybooleanWhether the account is marked as trade-only.
isExternalbooleanWhether the account is marked as an external account.

Selection and display guidance

  • Choose the correct list row using the pair primeType and id; the ID namespace is not a public numeric sequence.
  • Do not infer a RapidX venue from this list. RapidX can contain multiple exchanges, which are exposed when retrieving that Portfolio's detail.
  • Empty strings in a DMA-specific or RapidX-specific field are expected. They do not signal missing data.

Relevant errors

CodeWhen it occursWhat to do
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 not DMA or RAPIDX.Use one supported value or omit the filter.
100429The API key exceeds the rate limit.Back off before retrying.
Query Params
string
enum

Valuation currency. Defaults to USD.

Allowed:
string
enum

Optional account-family filter: DMA or RAPIDX. Omit to return both. Input is case-insensitive; response primeType values are lowercase.

Allowed:
string

DMA account ID or RapidX Portfolio ID filter.

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