Skip to main content

​
Account API

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

​
Endpoints

MethodEndpointDescription
GET/v1/account/balancesGet account balances

​
Balance Fields

Each balance includes:
FieldDescription
currentBalanceCurrent fiat currency balance
currencyCurrency code (e.g., USD)
buyingPowerCapital available for trading
assetNotionalTotal notional value of securities
assetAvailableAvailable collateral value
pendingCreditPending credit amounts
openOrdersValue tied up in open orders
unsettledFundsUnsettled funds not yet available
marginRequirementRequired 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:
FieldDescription
idWithdrawal identifier
balanceAmount to withdraw
statusWithdrawal status
creationTimeRequest timestamp
Real-Time Balance UpdatesFor 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"
    }
  ]
}