Ctrl+K

List total balances

get/api/v2/wallet/balances

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

Query Parameters

  • allTokensboolean
    Include balances for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • coinstring or array
    Filter by coin
    Example: btc | ['btc', 'eth']
  • deletedbooleanDefault: false
    Filter by deleted state
  • enterprisestring or array
    Filter by enterprise ID
  • excludeEmptyBalancesbooleanDefault: false
    Exclude tokens with zero balance. When allTokens is passed, then every token supported by BitGo will be included, regardless of balance.
  • excludeSpendableBalancesbooleanDefault: false
    Skip spendable balance calculations and only include confirmed balances. If absent, defaults to false.
  • expandCustodialWalletbooleanDefault: false
    Whether balances of linked custodial wallets should be included
  • idstring or array
    Filter by wallet ID
  • includeStakingBalancesbooleanDefault: false
    Include 'stakingBalanceString' and 'rewardBalanceString' properties for each staking wallet.
  • labelContainsstring
    Filter by label substring
  • skipPendingTxsbooleanDefault: false
    Do not include pending withdrawals when determining total balances. By default, pending withdrawals will be considered.
  • skipTxCountsbooleanDefault: false
    True, if excluding transfer counts when calculating total balances. If absent, defaults to false.
  • typestring or array
    Filter by wallet type

200 Response

balances array[object] required
coin string required
A cryptocurrency or token ticker symbol.
Min length: >= 1 characters
Example: btc
balanceString string required
String representation of the balance in base units. Guaranteed to not lose precision.
confirmedBalanceString string required
String representation of the confirmed balance in base units. Guaranteed to not lose precision.
spendableBalanceString string
String representation of the spendable in base units. Guaranteed to not lose precision. Will not be included if 'excludeSpendableBalances=false'
stakingBalanceString string
The staked balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.
rewardBalanceString string
The staking reward balance in base units. Guaranteed to not lose precision. The is only returned if the 'includeStakingBalances' query parameter is set to 'true'.

400 Response

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

401 Response

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

403 Response

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

404 Response

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

500 Response

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