REST API›Wallet & Transact›Wallet

GET

List total balances

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

Query Params

  • allTokens boolean
    Include balances for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • coin string or array of strings
    Filter by coin
  • deleted boolean
    Filter by deleted state

    Defaults to false

  • enterprise string or array of strings
    Filter by enterprise ID
  • excludeEmptyBalances boolean
    Exclude tokens with zero balance. When allTokens is passed, then every token supported by BitGo will be included, regardless of balance.

    Defaults to false

  • excludeSpendableBalances boolean
    Skip spendable balance calculations and only include confirmed balances. If absent, defaults to false.

    Defaults to false

  • expandCustodialWallet boolean
    Whether balances of linked custodial wallets should be included

    Defaults to false

  • id string or array of strings
    Filter by wallet ID
  • includeEvmKeyring boolean
    If true and wallet ID(s) are provided, include all wallets in the same EVM keyring family (parent + all children)

    Defaults to false

  • includeStakingBalances boolean
    Include stakingBalanceString and rewardBalanceString properties for each staking wallet.

    Defaults to false

  • labelContains string
    Filter by label substring
  • skipPendingTxs boolean
    Do not include pending withdrawals when determining total balances. By default, pending withdrawals will be considered.

    Defaults to false

  • skipTxCounts boolean
    True, if excluding transfer counts when calculating total balances. If absent, defaults to false.

    Defaults to false

  • type string or array of strings
    Filter by wallet type

    ONE OF

    string enum

Responses

200
OK

Response Body

object

  • balances array of objects required
    balances object
    • coin string required
      A cryptocurrency or token ticker symbol.
    • 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.
    • withdrawHoldAmountUsdString string
      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.
    • offchain object
      Lightning Balances
      offchain object
      • inboundBalance string required
        Inbound balance in millisatoshis (remote balance)
      • inboundPendingBalance string required
        Pending inbound balance in millisatoshis (pending open remote balance)
      • inboundUnsettledBalance string required
        Unsettled inbound balance in millisatoshis (unsettled remote balance)
      • outboundBalance string required
        Outbound balance in millisatoshis (local balance)
      • outboundPendingBalance string required
        Pending outbound balance in millisatoshis (pending open local balance)
      • outboundUnsettledBalance string required
        Unsettled outbound balance in millisatoshis (unsettled local balance)
      • outboundLockedBalance string required
        Locked (from pending force closed channels) outbound balance in millisatoshis (locked local balance)
      • outboundReservedBalance string required
        Total outbound reserved balance in millisatoshis (reserved local balance)
      • outboundSpendableBalance string required
        Total outbound spendable balance in millisatoshis (spendable local balance)
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id