Sign in
portfolio

Get Balance

Endpoint for getting the balance and portfolio value of a member. portfolio_value is always scoped to the requested exchange_index (defaulting to 0). When subaccount is omitted, balance is the primary account's aggregate available balance; pass subaccount explicitly (0 for primary, 1-63 for subaccounts) to read that subaccount's balance on the requested exchange index instead. 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. Defaults to 0 if unspecified.

Exchange index to scope the returned portfolio value to, and the balance when subaccount is provided. Defaults to 0.

Response

Balance retrieved successfully

balanceinteger required

Member's available balance in cents. This represents the amount available for trading.

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. This is the current value of the positions held by the requested subaccount on the requested exchange index.

updated_tsinteger required

Unix timestamp of the last update to the balance.

Example response

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