Accounts

Get Account Balance

Get balance information about a single trading account.

Requires access token scope: trade_view

get/api/prime/trading/v1/accounts/{accountId}/balances

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/prime/trading/v1/accounts/{accountId}/balances
  • Auth
    none declared

Path parameters

accountIdstring required

The ID of the account

Query parameters

includeUnsettledInAvailableboolean

Include unsettled trading balance in available balance. Withdrawals may be initiated from the unsettled available balance, but trading settlement must occur before the withdrawal can be processed. Default is false.

Response

An array of account balances

Example response

{
  "data": [
    {
      "currencyId": "6016e0a9-545a-45fb-8370-caab1680956a",
      "currency": "BTC",
      "balance": "100.0",
      "heldBalance": "10.0",
      "unsettledHeldBalance": "0.0",
      "tradableBalance": "90.0",
      "withdrawableBalance": "90.0"
    }
  ]
}

Changes

No operation changes recorded.