latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

List total balances

Returns total balances by asset across all wallets in an enterprise.

get/api/v2/wallet/balances

Query parameters

allTokensboolean

Include balances for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)

string

A cryptocurrency symbol or token ticker symbol

OR
string[]
Example:btc

Filter by coin

deletedboolean

Filter by deleted state

string
OR
string[]
Example:59cd72485007a239fb00282ed480da1f

Filter by enterprise ID

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.

expandCustodialWalletboolean

Whether balances of linked custodial wallets should be included

string
OR
string[]
Example:59cd72485007a239fb00282ed480da1f

Filter by wallet ID

includeEvmKeyringboolean

If true and wallet ID(s) are provided, include all wallets in the same EVM keyring family (parent + all children)

includeStakingBalancesboolean

Include stakingBalanceString and rewardBalanceString properties for each staking wallet.

labelContainsstring

Filter by label substring

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.

'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'advanced' | 'trading'
OR
string[]

Filter by wallet type

Response

OK

Example response

{
  "balances": [
    {
      "coin": "btc"
    }
  ]
}