Wallet

List total balances by coin

Returns total balances by asset (including tokens and NFTs) across all wallets in an enterprise.

get/api/v2/{coin}/wallet/balances

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/{coin}/wallet/balances
  • Auth
    none declared

Path parameters

coinstring required

A cryptocurrency symbol or token ticker symbol

Example:btc

Query parameters

allTokensboolean

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

string
OR
string[]
Example:59cd72485007a239fb00282ed480da1f

Filter by enterprise ID

showAllWalletsboolean

Include wallets that have 'deleted' or 'creationFailed' set to true

includeStakingBalancesboolean

Include stakingBalanceString and rewardBalanceString properties for each staking wallet.

Response

OK

balancenumber required

The total balance of all wallets containing the given coin type. May lose precision for large values.

confirmedBalancenumber required

The total balance of confirmed transactions for all wallets containing the given coin type. May lose precision for large values.

spendableBalancenumber required

The total balance of all wallets containing the given coin which may be used as inputs for creating new transactions. May lose precision for large values.

stakedBalancenumber

The total balance of all wallets containing the given coin which has been staked. May lose precision for large values.

stakedBalanceStringstring

String representation of 'stakedBalance'. Guaranteed to not lose precision.

tokensTokenBalances
unsupportedTokensTokenBalances
balanceStringstring required

String representation of the total balance of all wallets containing the given coin type. Guaranteed to not lose precision.

confirmedBalanceStringstring required

String representation of the total balance of confirmed transactions for all wallets containing the given coin type. Guaranteed to not lose precision.

spendableBalanceStringstring required

String representation of the total balance of all wallets containing the given coin which may be used as inputs for creating new transactions. Guaranteed to not lose precision.

stakingBalanceStringstring

The staked balance in base units. Guaranteed to not lose precision. The is only returned if the includeStakingBalances query parameter is set to true.

rewardBalanceStringstring

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.

withdrawHoldAmountUsdStringstring

Total USD value (in cents) of active ACH-deposit related withdraw holds on this wallet. Only present for OFC wallets when allTokens=true is passed.

Changes

No operation changes recorded.