Sign in

v1

latestOpenAPI 3.0.02026-07-2442138225.7 KB
Portfolio

Get account balance

Retrieve account balance and margin for one provider. Use providerId or providerIds with exactly one provider (not multiple).

post/v1/balances

Request body

providerId'hyperliquid' | 'hyperliquid-xyz'

Single provider identifier. At least one of providerId or providerIds must be provided.

providerIdsstring[]

Single provider only (one CSV value, one repeated param, or a one-element JSON array). At least one of providerId or providerIds must be provided. Must not combine with a different providerId.

addressstring required

User wallet address

Example request

{
  "providerId": "hyperliquid",
  "providerIds": [
    "hyperliquid"
  ],
  "address": "0x1234..."
}

Response

Account balance

providerIdstring required

Provider ID

accountValuenumber required

Total account value in collateral asset

usedMarginnumber required

Margin used by positions in collateral asset

availableBalancenumber required

Available balance for new positions in collateral asset

unrealizedPnlnumber required

Total price PnL across all positions in collateral asset (excludes funding)

unifiedAccountModeboolean

Whether the account currently has Unified Account Mode enabled (collateral unified across venues). Only present for providers that support it (Hyperliquid).

Example response

{
  "providerId": "hyperliquid",
  "collateral": {
    "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6
  },
  "accountValue": 1280.44,
  "usedMargin": 320.13,
  "availableBalance": 960.31,
  "unrealizedPnl": 12.8
}