Ctrl+K

Get Internal Wallet Balance

get/api/v2/internal/{coin}/wallet/{walletId}/balance

Route to get internal wallet balance

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
    Min length: >= 1 characters
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • allTokensboolean
    Include data for all subtokens (i.e. ERC20 Tokens, Stellar Tokens)
  • unspentCountboolean
    True, if including unspent count for UTXO-based coins.
  • includeRbfboolean
    True, if including Replace-By-Fee (RBF) transactions in the total balance amount.
  • includeStakingBalancesboolean
    Includes the staked balance and reward balance of the wallet

200 Response

balanceString string required
The current balance of the wallet
confirmedBalanceString string required
The confirmed balance of the wallet
spendableBalanceString string
The spendable balance of the wallet, will not be included if `excludeSpendableBalance=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