Ctrl+K

Get enterprises balances

get/api/v2/admin/enterprises/balances

Query Parameters

  • enterpriseIdsarray[string]
    array of enterprise ids to fetch the wallets of
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • enterpriseBitgoOrgstring
  • coinsarray[string]
    array of coins to fetch wallets of
    Example: btc
  • getAllTrustWalletsboolean
    pass this if you want all trust wallets, overrides enterprise id, coins and types params
  • includeDeletedboolean
    pass this if you want to return deleted wallets

200 Response

balances array[object]
balance integer
The total balance of all wallets containing the given coin type. May lose precision for large values.
Example: 50000
balanceString string
String representation of `balance`. Guaranteed to not lose precision.
Example: 50000
confirmedBalance
integer or null
The total balance of confirmed transactions for all wallets containing the given coin type. May lose precision for large values.
Example: 40000
confirmedBalanceString string
String representation of `confirmedBalance`. Guaranteed to not lose precision.
Example: 40000
spendableBalance
integer or null
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.
Example: 40000
spendableBalanceString string
String representation of `spendableBalance`. Guaranteed to not lose precision.
Example: 40000
stakedBalance
integer or null
The total balance of all wallets containing the given coin which has been staked. May lose precision for large values.
Example: 40000
stakedBalanceString string
String representation of `stakedBalance`. Guaranteed to not lose precision.
Example: 40000
coin string
A cryptocurrency or token ticker symbol.
Example: btc
enterpriseName string
enterpriseId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$

400 Response

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