Ctrl+K

List total balances by coin

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

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

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc

Query Parameters

  • allTokensboolean
    Include balances for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • enterprisestring or array
    Filter by enterprise ID
  • showAllWalletsbooleanDefault: false
    Include wallets that have 'deleted' or 'creationFailed' set to **true**
  • includeStakingBalancesbooleanDefault: false
    Include `stakingBalanceString` and `rewardBalanceString` properties for each staking wallet.

200 Response

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 dictionary<string, any>
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.
baseBalanceStrings object
unsupportedTokens dictionary<string, any>
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
baseBalanceStrings object
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`.

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