API Reference

Query Account Overview

Description

Returns the margin & risk overview of your trading portfolio on each connected exchange (e.g. BINANCE, OKX, EDX).

Each object in data[] represents the same portfolio on one venue.

Rate Limit

2 requests per 1s.

Permission

  • Accessible by Main or Sub Trading Portfolio API keys with read permission.

Request

This endpoint does not require any request parameters.

Response

FieldTypeDescription
portfolioIdStringtrading portfolio ID to which this account view belongs.
exchangeTypeStringRapidX Venue / exchange of this trading account, e.g. BINANCE, OKX, EDX.
equityStringTotal account equity on this venue, valued in USDT-equivalent (including cash balance and P&L).
maintainMarginStringMaintenance margin requirement for all open positions on this venue.
positionValueStringNotional value of all open positions on this venue.
uniMMRStringUnified maintenance margin rate / internal risk metric. Higher value means higher margin requirement.
riskRatioStringRisk ratio of this account (0–1 or 0–100% depending on UI), used for risk display and liquidation checks.
accountStatusStringTrading account status, e.g. NORMAL.
marginValueStringTotal margin balance on this venue (after conversion to the unified margin currency).
frozenMarginStringMargin currently locked (e.g. for open orders or positions) and not available for new trades or withdrawal.
perpMarginStringMargin allocated specifically to perpetual contracts.
debtMarginStringBorrowed margin or negative balance amount (if any).
openLossMarginStringMargin portion reserved to cover current open losses.
validMarginStringEffective margin after deducting open loss, used for risk and liquidation calculations.
availableMarginStringMargin available for opening new positions or for withdrawal.
upnlStringUnrealized P&L (profit and loss) on this venue.
positionModeStringPosition mode on this venue, e.g. NET (one-way) or HEDGE (dual-side) depending on exchange settings.
Language
Credentials
OAuth2