Sign in
portfolio

Get Balance

Returns the balance and portfolio value for a member. Both values include all exchange indexes unless exchange_index is provided. Pass subaccount to use a subaccount instead of the primary account. This endpoint also accepts API keys with the 'read::portfolio_balance' scope.

get/portfolio/balance

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0.

exchange_indexinteger

Identifier for an exchange shard.

Exchange index used to scope the balance and portfolio value. If omitted, both include all exchange indexes.

Response

Balance retrieved successfully

balanceinteger required

Member's available balance in cents for the requested account and exchange index. It includes all exchange indexes when exchange_index is omitted.

balance_dollarsstring required

Fixed-point US dollar string. Most request fields accept 2-4 decimal places (e.g., "0.56", "0.5600"); responses emit up to 6. Valid quote intervals for a given market are constrained by that market's price level structure.

portfolio_valueinteger required

Member's portfolio value in cents for the requested account and exchange index. It includes all exchange indexes when exchange_index is omitted.

updated_tsinteger required

Unix timestamp of the last update to the balance.

Example response

{
  "balance_dollars": "0.5600",
  "balance_breakdown": [
    {
      "balance": "0.5600"
    }
  ]
}