Ctrl+K

List total balances

get/api/v2/wallet/balances

Selects wallets based on the given filter parameters. Gets all balances for the selected wallets and sums up the balances by coin.

Query Parameters

  • coinarray[string]
    Filter by coin
    Example: btc
  • deletedarray[boolean]
    Filter by deleted state
  • enterprisearray[string]
    Filter by enterprise.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • idarray[string]
    Filter by ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • labelContainsstring
    Filter by label substring
  • typearray[string]
    Filter by wallet type
    Enum: cold custodial custodialPaired hot trading distributedCustody
  • expandCustodialWalletboolean
    Whether balances of linked custodial wallets should be included
  • skipPendingTxsboolean
    Do not include pending withdrawals when determining total balances. By default, pending withdrawals will be considered.
  • skipTxCountsboolean
    True, if excluding transfer counts when calculating total balances. If absent, defaults to false.
  • excludeEmptyBalancesboolean
    Exclude tokens with zero balance. When allTokens is passed, then every token supported by BitGo will be included, regardless of balance.
  • excludeSpendableBalancesboolean
    Skip spendable balance calculations and only include confirmed balances. If absent, defaults to false.

200 Response

balances array[object]
balanceString string
String representation of the balance in base units. Guaranteed to not lose precision.
Example: 2000000
Match pattern: ^-?\d+$
coin string
A cryptocurrency or token ticker symbol.
Example: btc

400 Response

error string required
Human-readable error message
requestId string required
Client request id
context object
Properties that apply to a specific error name
name string required
Error code