Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

Get wallet by ID

Get one wallet by its 'walletId'. One 'walletId' can map to multiple receive addresses.

get/api/v2/wallet/{walletId}

Path parameters

walletIdstring required
Example:59cd72485007a239fb00282ed480da1f

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.

expandAdvancedWhitelistboolean

True, if including the advanced whitelist wallet address in the response. The address is annotated as part of the whitelist entry metadata

includeStakingBalancesboolean

Includes the staked balance and reward balance of the wallet

includeBalanceboolean

Omit trying to fetch the wallet balance

includeEvmKeyringWhitelistboolean

When true, includes whitelist policy rules from all EVM keyring derived wallets in addition to the main wallet's rules. Each merged rule is tagged with the source walletId so the caller can identify which network it belongs to. Only applicable for EVM keyring wallets (parent or derived).

exactConfirmedBalanceboolean

When set to true, the confirmedBalance in the response will be the exact on-chain balance without considering any unconfirmed transactions (for UTXO-based coins only).

When false, the confirmedBalance will not include the outputs consumed of unconfirmed withdrawals. This may be inaccurate in certain situations

Default value: false.

Response

OK

allowBackupKeySigningboolean required
approvalsRequirednumber required
coinstring required

A cryptocurrency symbol or token ticker symbol

deletedboolean required
disableTransactionNotificationsboolean required
hasLargeNumberOfAddressesboolean nullable required
idstring required
isColdboolean required
labelstring required
startDatestring date-time required

Wallet creation time

billingEnterprisestring
custodialWalletIdstring
customerWalletIdstring
enterprisestring
evmKeyRingReferenceWalletIdstring

Reference wallet ID for EVM keyring wallets (child wallets only)

isParentboolean

Indicates if this wallet is a parent wallet in an EVM keyring setup

enabledChildChainsstring[]
archivedChildChainsstring[]
organizationstring
bitgoOrgstring
instantProviderstring
keysstring[]
mnumber

Number of signatures required. This value must be 2 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.

migratedFromstring
multisigType'onchain' | 'tss'
multisigTypeVersion'MPCv2'
nnumber

Number of keys provided. This value must be 3 for hot wallets, 1 for ofc wallets, and not specified for custodial wallets.

recoverableboolean
tagsstring[]
type'backing' | 'cold' | 'custodial' | 'custodialPaired' | 'hot' | 'advanced' | 'trading'
subType'distributedCustody' | 'pairedCustodial' | 'custodialHot' | 'custodialCold' | 'lightningCustody' | 'lightningSelfCustody' | 'onPrem'
balanceStringstring

The cleared balance of the address in base units (e.g. Satoshis). Guaranteed to not lose precision. The is only returned if the expandBalance query parameter is set to true.

balancenumber

The cleared balance of the address in base units (e.g. Satoshis). The is only returned if the expandBalance query parameter is set to true.

confirmedBalanceStringstring

The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the expandBalance query parameter is set to true. Guaranteed to not lose precision.

confirmedBalancenumber

The total balance of confirmed transactions in base units (e.g. Satoshis). The is only returned if the expandBalance query parameter is set to true.

spendableBalanceStringstring

The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision. The is only returned if the expandBalance query parameter is set to true.

spendableBalancenumber

The total balance in base units (e.g. Satoshis) which may be used as inputs for creating new transactions in string representation. The is only returned if the expandBalance query parameter is set to true.

stakingBalanceStringstring

The staked balance in base units. Guaranteed to not lose precision. The is only returned if the includeStakingBalances query parameter is set to true.

rewardBalanceStringstring

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.

withdrawHoldAmountUsdStringstring

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.

customTagsstring[]
safestring

Public id of the safe that minted this wallet. Absent on non-safe wallets.

Example response

{
  "approvalsRequired": 1,
  "coin": "btc",
  "id": "59cd72485007a239fb00282ed480da1f",
  "label": "My Wallet",
  "admin": {
    "policy": {
      "id": "59cd72485007a239fb00282ed480da1f",
      "rules": [
        {
          "coin": "btc",
          "condition": {
            "amountString": "2000000"
          }
        }
      ],
      "walletId": "59cd72485007a239fb00282ed480da1f"
    }
  },
  "buildDefaults": {
    "minFeeRate": 12000
  },
  "custodialWalletId": "59cd72485007a239fb00282ed480da1f",
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "evmKeyRingReferenceWalletId": "59cd72485007a239fb00282ed480da1f",
  "isParent": true,
  "enabledChildChains": [
    "tbsc",
    "tpolygon"
  ],
  "archivedChildChains": [
    "tbsc",
    "tpolygon"
  ],
  "keys": [
    "585951a5df8380e0e304a553",
    "585951a5df8380e0e30d645c",
    "585951a5df8380e0e30b6147"
  ],
  "m": 2,
  "n": 3,
  "receiveAddress": {
    "coin": "btc",
    "id": "59cd72485007a239fb00282ed480da1f",
    "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
    "balance": {
      "balanceString": "500000",
      "confirmedBalanceString": "400000",
      "spendableBalanceString": "40000",
      "balance": 50000
    },
    "label": "Bob's Hot Wallet Address"
  },
  "safe": "59cd72485007a239fb00282ed480da1f"
}