Get Portfolio Overview

GET https://api.liquiditytech.com/api/v1/trading/account

Returns the margin and risk overview of the RapidX Portfolio associated with the API key. Each object in data[] represents that Portfolio on one exchange, such as BINANCE, OKX or EDX.

The Main User Level key queries the Main Portfolio, not an aggregate of all Sub Portfolios. A dedicated Sub Portfolio key queries only its own Portfolio.

API key access

Requires a signed LTP Open API request with READ permission.

API key type	Can call	Scope
Main User Level API key (also the main Portfolio key)	Yes	The Main Portfolio only.
Sub-user Level API key	No	Not supported by this endpoint.
Dedicated Sub Portfolio API key	Yes	The Portfolio associated with this key only.

Rate limit: 2 requests per second.

Request Parameters

This endpoint does not require any request parameters.

Response fields

Field	Type	Description
code	integer	Application result code. 200000 means success.
message	string	Result message.
data	array	Per-exchange overview entries for the current Portfolio.

Overview entry: data[]

Field	Type	Description
portfolioId	String	trading portfolio ID to which this account view belongs.
exchangeType	String	RapidX Venue / exchange of this trading account, e.g. BINANCE, OKX, EDX.
equity	String	Total account equity on this venue, valued in USDT-equivalent (including cash balance and P&L).
maintainMargin	String	Minimum margin required across all positions to avoid liquidation.
positionValue	String	Notional value of all open positions on this venue.
uniMMR	String	validMargin/maintainMargin. Unified maintenance margin rate, used to measure risk, a forced liquidation is triggered when the value is below 100%..
riskRatio	String	1/uniMMR.
accountStatus	String	Current account status: NORMAL (healthy), MARGIN_CALL (approaching liquidation threshold), LIQUIDATED (liquidation in progress)
marginValue	String	Total margin value on this venue.
frozenMargin	String	Locked margin (e.g. for open orders or positions) and unavailable for new trades or withdrawal.
perpMargin	String	Margin allocated specifically to perpetual contracts.
debtMargin	String	Margin used to cover borrowing and negative balances.
openLossMargin	String	Margin portion reserved to cover current open losses.
validMargin	String	marginValue-openLossMargin
availableMargin	String	Margin available for opening new positions or for withdrawal.
upnl	String	Unrealized profit and loss of the account in USDT.
positionMode	String	Position mode on this venue, e.g. NET (one-way) or BOTH (dual-side) depending on exchange settings.

Example Response

JSON

{
  "code": 200000,
  "message": "Success",
  "data": [
    {
      "portfolioId": "17xxxxxxxxxxxxxx",
      "exchangeType": "BINANCE",
      "equity": "5685978.07787916",
      "maintainMargin": "164182.02640801",
      "positionValue": "3465349.06217066",
      "uniMMR": "28.4139281239",
      "riskRatio": "0.0352",
      "accountStatus": "NORMAL",
      "marginValue": "4666269.16976568",
      "frozenMargin": "482754.35903806",
      "perpMargin": "482754.35903806",
      "debtMargin": "0",
      "openLossMargin": "1212.87217175",
      "validMargin": "4665056.29759393",
      "availableMargin": "4182301.93855587",
      "upnl": "4654259.07370681",
      "positionMode": "NET"
    }
  ]
}

A Sub-user Level key returns application code 100003 (invalid user type). Check the application code even when HTTP status is 200. See Error codes.