API Reference

Get User All Portfolio Asset

Description

Retrieve all asset balances for the current user across every RapidX portfolio, including both:

  • Main portfolio
  • All associated sub portfolios

For each portfolio, this endpoint returns the same per-asset structure as GET /api/v1/trading/portfolio/assets, grouped by portfolioId.

This is useful for building a global user asset overview across multiple portfolios and venues.

Permission

  • Only RapidX main portfolio API keys are allowed
  • Read-only permission is sufficient

Rate Limit

20 requests per 1 second.

Request

This endpoint does not require any request parameters.

Response

Top-level

FieldTypeDescription
codeIntegerBusiness status code. 200000 means success.
messageStringText message for the response.
dataObjectMap of portfolioId → asset list.

data Object

data is a dictionary whose keys are portfolioId strings. Each key maps to an array of asset records for that portfolio.

  • Key: String — portfolio ID (main or sub)
  • Value: Array of asset records for that portfolio

Example structure:

"data": {
  "1726371398908000": [ { ...asset record... }, ... ],
  "2082325504644932": [ { ...asset record... }, ... ]
}

Asset Record (data[portfolioId][])

Each asset record has the same structure as GET /api/v1/trading/portfolio/assets:

FieldTypeDescription
portfolioIdStringID of the RapidX portfolio (main or sub) that owns this asset.
coinStringAsset symbol, e.g. USDT, BTC, ADA.
exchangeTypeStringExchange / venue where this asset is held, e.g. BINANCE, OKX, EDX.
balanceStringTotal quantity of this asset in this portfolio on this venue.
availableStringQuantity of this asset that is freely available for trading / transfer.
frozenStringQuantity locked (e.g. in open orders or pending operations).
debtStringDebt amount for this asset (for margin environments). 0 if no borrowing.
equityStringAsset equity in units of the asset itself.
createAtStringRecord creation time, Unix timestamp in milliseconds.
updateAtStringLast update time, Unix timestamp in milliseconds.
borrowStringCurrent borrowed amount of this asset, if any.
overdrawStringOverdrawn amount (if negative balance logic applies). Usually 0.
indexPriceStringReference index price for this asset (e.g. in USDT), used for valuation and risk.
marginValueStringMargin value contributed by this asset, generally equity * indexPrice after haircuts.
virtualBorrowStringSynthetic / virtual borrow amount used by the risk engine, if applicable.
upnlStringUnrealized P&L associated with this asset. 0 if not tracked at asset level.
debtMarginStringMargin requirement or value associated with the debt portion of this asset.
perpMarginStringMargin allocated from this asset for perpetual / derivatives positions.
maxTransferableStringMaximum quantity of this asset that can be safely transferred out, considering margin and risk constraints.
equityValueStringAsset equity value converted into the risk base currency (e.g. USDT), typically equity * indexPrice.
Language
Credentials
OAuth2