Query V1 account lists and asset balances. V1 endpoints remain supported.
V1 to V2: which endpoint should I use?
The following V2 endpoints cover common V1 asset-query use cases. They use different request parameters and response structures; they are not drop-in replacements.
| V1 endpoint | V2 alternative | Scope and limitations |
|---|---|---|
| Get Account List | Get Trading Account List, with primeType=DMA for DMA accounts | Covers DMA account discovery and also supports RapidX Portfolios. It does not return Funding or ClearLoop rows, or the V1 exchangeUid field. Query Funding balances separately; keep V1 if you need ClearLoop account discovery or exchange UIDs. |
| Get Account Balance | Get Funding Account Assets for Funding; Get Trading Account Assets for a DMA account | Funding is queried separately. Trading detail accepts one account ID per request; list DMA accounts first and query their details when you need balances across multiple accounts. Trading V2 does not expose the V1 withdrawAvailable field. |
| Get Portfolio (under RapidX Trading → Portfolios) | Recommended: Get Trading Account List, with primeType=RAPIDX&hideDust=false | Use V2 for Portfolio listing: portfolioId → id, name → accountName, belongingTo 0/2 → portfolioType MAIN/SUB. Retrieve all pages; filter returned names or main/sub types in your client when needed. V1 remains supported. |
| Get Currencies (under Asset Information) | No equivalent in the current Account Assets V2 release | This endpoint queries supported currencies, networks and operation availability, not held balances. Continue using V1. |
If you only need combined holdings per currency, use Get Trading Asset Summary. Set primeType=DMA or RAPIDX to select one account family. This summary does not replace account/venue-level detail.
RapidX-specific asset data
Get All Portfolio Assets, under RapidX Trading → REST → Portfolios, is a separate RapidX-specific API. It provides detailed Portfolio assets, margin and transfer-limit fields, including marginValue and maxTransferable. It remains supported alongside Account Assets V2 and is not part of the replacement mapping above. No separate V2 version is planned for this endpoint.
Before migrating
- Access: V2 Trading queries accept Main User Level and Sub-user Level API keys within their permitted account scope. Dedicated Sub Portfolio keys are not supported. V2 Funding requires a Main User Level key.
- Complete results: set
hideDust=falseto include low-value accounts and holdings. Read every page of the Trading Account List or Trading Asset Distribution; both default to page 1 with 20 items. - Valuation: V2 defaults to
quoteCurrency=USD. SpecifyUSDTwhen you need USDT-denominated values. - Response handling: V2 uses application success code
200and adataobject. Update your parser to use the response structure documented for each endpoint. - Rate limit: Account Assets V2 allows 10 requests per minute per API key. Do not carry over a V1 polling schedule without checking this limit.
- Operation limits: a Trading V2
availablebalance is not a replacement for the V1withdrawAvailablefield. Funding V2 provides its ownwithdrawablefield; use the documented currency/network and operation rules for the relevant workflow.
Deposit, withdrawal, transfer, address and history APIs, ClearLoop, and asset-operation availability queries continue to use V1 until their corresponding V2 APIs are released. Moving asset queries to V2 does not require changing those V1 integrations.