Skip to main content
GET
Get account balances

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

exchanges

Supported perpetual exchange

Available options:
aster,
binance,
bybit,
extended,
gate,
hyperliquid,
lighter,
mexc,
ondo,
robinhood

Response

availableMargin
string
required

Free margin available for new positions.

Example:

"800.00"

exchange
enum<string>
required

Perpetual exchange

Available options:
aster,
binance,
bybit,
extended,
gate,
hyperliquid,
lighter,
mexc,
ondo,
robinhood
marginInUse
string
required

Total initial margin locked across positions and open orders.

Example:

"200.00"

token
string
required

Quote/collateral token denominating the balances (e.g. "USDC", "USDH").

Example:

"USDC"

totalBalance
string
required

Total account equity, including unrealized PnL.

Example:

"1000.00"

type
string
required

Account type within the exchange. Defaults to "perps"; Hyperliquid returns one account per supported dex (e.g. "perps", "xyz").

Example:

"perps"

withdrawable
string
required

Amount available for withdrawal.

Example:

"750.00"