API Reference

Get One Portfolio Assets Details

Description

Retrieve the per-asset balance details for the current RapidX main or sub portfolio.

This endpoint returns, for each coin and exchange:

  • Wallet-style balances: balance, available, frozen, debt
  • Margin-related values: marginValue, equity, equityValue, upnl, debtMargin, perpMargin, virtualBorrow, overdraw
  • Risk-related values: maxTransferable, indexPrice

The result is paginated, and each record corresponds to one asset on one exchange under the current portfolio.

Permission

RapidX API key with read-only permission is sufficient. No trading / write permission is required.

The API key determines which portfolio (main or sub) the assets are returned for. You cannot use this endpoint to query other portfolios.

Rate Limit

20 requests per 1 second

Request

All parameters are optional. If omitted, the system will return all supported exchanges for the current portfolio, paginated.

FieldTypeNecessaryDescription
exchangeTypeStringNFilter by exchange / venue, e.g. BINANCE, OKX, EDX. If omitted, return assets across all exchanges bound to this portfolio.
pageIntegerNPage number, starting from 1. Default is 1.
pageSizeIntegerNNumber of records per page. Default is 1000.

Response

Top-level

FieldTypeDescription
codeIntegerBusiness status code. 200000 indicates success.
messageStringText message for the response.
dataObjectPagination information and asset list.

Data Object

FieldTypeDescription
pageIntegerCurrent page index (same as pageNum), starting from 1.
pageSizeIntegerPage size used for this query.
pageNumIntegerAlias for current page index.
totalSizeIntegerTotal number of records matching the filters.
listArrayList of asset records. Each element represents one coin on one exchange.

Asset Record (list[])

FieldTypeDescription
portfolioIdStringID of the RapidX portfolio (main or sub) to which this asset belongs.
coinStringAsset symbol, e.g. USDT, BTC.
exchangeTypeStringExchange / venue where the asset is held, e.g. BINANCE, OKX, EDX.
balanceStringTotal quantity of this asset in the portfolio on this exchange (including available + frozen + any debt-related offsets as per venue rules).
availableStringQuantity of this asset that is freely available for trading or transfer.
frozenStringQuantity currently locked (e.g. in open orders, pending withdrawals, or other holds).
debtStringDebt amount of this asset (for margin environments). 0 if no borrowing.
equityStringAsset equity in units of the asset itself.
createAtStringRecord creation time as Unix timestamp in milliseconds.
updateAtStringLast update time as Unix timestamp in milliseconds.
borrowStringCurrently borrowed quantity of this asset (if supported by the venue/account type).
overdrawStringOverdrawn amount (if the portfolio supports overdraw / negative balance logic). Usually 0 in normal cases.
indexPriceStringReference index price for this asset (typically in USDT or quote currency), used for valuation and margin calculations.
marginValueStringMargin value contributed by this asset, usually equity * indexPrice adjusted for margin haircuts, expressed in the risk base currency (e.g. USDT).
virtualBorrowStringSynthetic / virtual borrow amount used by the risk engine, if any. Normally 0 when not applicable.
upnlStringUnrealized P&L associated with this asset (if the venue / account type maps it at asset level). 0 when not applicable.
debtMarginStringMargin requirement or value associated specifically 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 withdrawn / transferred out, considering margin requirements and risk limits.
equityValueStringAsset equity value converted into the risk base currency (e.g. USDT), typically equity * indexPrice.
Language
Credentials
OAuth2