Account API Overview

View account balances and information

Account API

The Account API provides access to user account balances and financial information.

Endpoints

Method	Endpoint	Description
GET	/v1/account/balances	Get account balances

Balance Fields

Each balance includes:

Field	Description
currentBalance	Current fiat currency balance
currency	Currency code (e.g., USD)
buyingPower	Capital available for trading
assetNotional	Total notional value of securities
assetAvailable	Available collateral value
pendingCredit	Pending credit amounts
openOrders	Value tied up in open orders
unsettledFunds	Unsettled funds not yet available
marginRequirement	Required margin for positions

Buying Power

The buyingPower field represents unencumbered capital available for trading:

buyingPower = currentBalance
            + assetAvailable
            - openOrders
            - marginRequirement

This accounts for:

• Cash balance
• Available collateral from positions
• Capital reserved for open orders
• Margin requirements

Pending Withdrawals

The pendingWithdrawals array contains any active withdrawal requests:

Field	Description
id	Withdrawal identifier
balance	Amount to withdraw
status	Withdrawal status
creationTime	Request timestamp

Real-Time Balance Updates

For real-time balance changes, use the WebSocket Private Stream with the SUBSCRIPTION_TYPE_ACCOUNT_BALANCE subscription instead of polling.

Example Response

{
  "balances": [
    {
      "currentBalance": 1000.00,
      "currency": "USD",
      "buyingPower": 850.00,
      "assetNotional": 500.00,
      "assetAvailable": 250.00,
      "openOrders": 400.00,
      "unsettledFunds": 0,
      "marginRequirement": 0,
      "lastUpdated": "2024-01-15T10:30:00Z"
    }
  ]
}