REST API›Wallet & Transact›Wallet

GET

List total balances by coin

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

Path Params

  • coin string required
    A cryptocurrency symbol or token ticker symbol

Query Params

  • allTokens boolean
    Include balances for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • enterprise string or array of strings
    Filter by enterprise ID
  • showAllWallets boolean
    Include wallets that have 'deleted' or 'creationFailed' set to true

    Defaults to false

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

    Defaults to false

Responses

200
OK

Response Body

object

  • balance number required
    The total balance of all wallets containing the given coin type. May lose precision for large values.
  • confirmedBalance number required
    The total balance of confirmed transactions for all wallets containing the given coin type. May lose precision for large values.
  • spendableBalance number 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.
  • stakedBalance number
    The total balance of all wallets containing the given coin which has been staked. May lose precision for large values.
  • stakedBalanceString string
    String representation of 'stakedBalance'. Guaranteed to not lose precision.
  • tokens map of objects
    Object of key value pairs where the keys are the token symbols (e.g. omg) and the values are the balance data for that token symbol.
    tokens object
    • <key> object
      value object
      • transferCount number required
        Number of transfers for the token.
      • heldBalanceString string
        The difference between the balanceString and the spendableBalanceString.
      • balanceString string required
        String representation of the total balance of all wallets containing the given coin type. Guaranteed to not lose precision.
      • confirmedBalanceString string required
        String representation of the total balance of confirmed transactions for all wallets containing the given coin type. Guaranteed to not lose precision.
      • spendableBalanceString string 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.
      • 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.
  • unsupportedTokens map of objects
    Object of key value pairs where the keys are the unsupported token contracts (e.g. 0x9928e4046d7c6513326ccea028cd3e7a91c7590a) and the values are the balance data for that token contract. UnsupportedTokens will only be returned for wallets that supports Metamask Institutional and has enableMMI flag turned on
    unsupportedTokens object
    • <key> object
      value object
      • transferCount number required
        Number of transfers for the token.
      • heldBalanceString string
        The difference between the balanceString and the spendableBalanceString.
      • balanceString string required
        String representation of the total balance of all wallets containing the given coin type. Guaranteed to not lose precision.
      • confirmedBalanceString string required
        String representation of the total balance of confirmed transactions for all wallets containing the given coin type. Guaranteed to not lose precision.
      • spendableBalanceString string 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.
      • 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.
  • balanceString string required
    String representation of the total balance of all wallets containing the given coin type. Guaranteed to not lose precision.
  • confirmedBalanceString string required
    String representation of the total balance of confirmed transactions for all wallets containing the given coin type. Guaranteed to not lose precision.
  • spendableBalanceString string 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.
  • 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.
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