Get one wallet by its 'coin' and 'walletId'. One 'walletId' can map to multiple receive addresses.
Path Parameters
coinstringRequired
A cryptocurrency or token ticker symbol.
Example: btc
walletIdstringRequired
Example: 59cd72485007a239fb00282ed480da1f
Pattern: ^[0-9a-f]{32}$
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.
expandAdvancedWhitelistbooleanDefault: false
True, if including the advanced whitelist wallet address in the response. The address is annotated as part of the whitelist entry metadata.
200 Response
adminobject
policyobject
allowBackupKeySigningboolean
approvalsRequiredintegerrequired
Minimum: >= 1
Example: 1
balanceStringstring
String representation of 'balance'. Guaranteed to not lose
precision.
Example: null
Match pattern: ^-?\d+$
buildDefaultsobject
minFeeRate
integer or null
(UTXO only) Wallet-level minimum fee rate that must be greater than or equal to the default of 1000 satoshis/kvByte. Per transaction, you can override 'minFeeRate' with the 'feeRate' parameter.
Minimum: >= 1000
Example: 12000
maxFeeRate
integer or null
(UTXO only) Wallet-level maximum fee rate that must be greater than or equal to the default of 1000 satoshis/kvByte. Per transaction, you can override 'maxFeeRate' with the 'feeRate' parameter.
Minimum: >= 1000
Example: 18000
feeMultiplier
number or null
(UTXO only) Wallet-level custom multiplier for fee rate that must be greater than 1. The default multiplier is 1.2. The maximum fee rate still limits the new fee.
Minimum: >= 1
Example: 1.2
changeAddressTypestring
(UTXO only) The default script type to use for change for this wallet. Per transaction, you override the default with the 'changeAddressType' parameter. If 'default' is provided, it will clear the 'changeAddressType' default on the wallet. Note that each UTXO coin has different address types available. For example, Only BTC supports 'p2tr'.
Whether the wallet needs to be initialized on the chain
custodialWalletobject
The associated custodial wallet object
custodialWalletIdstring
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
deletedbooleanrequired
disableTransactionNotificationsbooleanrequired
enterprisestring
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
freezeobject
timestring<dateTime>
expiresstring<dateTime>
idstringrequired
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isColdboolean
keysarray[string]
Example: 59cd72485007a239fb00282ed480da1f
labelstringrequired
Example: My Wallet
minteger
Number of signatures required. This value must be 2 for
hot wallets, 1 for **ofc** wallets, and not specified for custodial
wallets.
Example: 2
ninteger
Number of keys provided. This value must be 3 for hot wallets,
1 for **ofc** wallets, and not specified for custodial wallets.
Example: 3
nodeIdstring
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
receiveAddressobject
idstring
platform public id for an address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
addressstring
Max length: <= 250 characters
Example: 2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS
chaininteger
Allowed values: 011011202130314041
Example: 1
indexinteger
coinstring
lastNonceinteger
Default: -1
walletstring
The wallet which contains this address
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
coinSpecificobject
Properties which are specific to certain coin types
balanceobject
Balance of the address. In case of Eth and Celo, if returnBalancesForToken is passed with includeBalances, then it will return token balance in the address object. This field will be present only when 'includeBalances' query param is passed as true.
label
string or null
A human-readable label for the address.
Max length: <= 250 characters
Example: Bob's Hot Wallet Address
addressTypestring
Allowed values: p2shp2shP2wshp2wshp2trp2trMusig2
Example: p2sh
recoverableboolean
tagsarray[string]
Example: 59cd72485007a239fb00282ed480da1f
spendableBalanceStringstring
String representation of 'spendableBalance'. Guaranteed to not lose
precision.
Example: null
Match pattern: ^-?\d+$
unspentCountnumber
Number of unspent outputs present in the wallet
Example: 100
startDatestring<date-time>
Wallet creation time
Example: {}
typestring
The type describes who owns the keys to the wallet and how they are stored. 'cold' wallets are wallets where the private key of the user key is stored exclusively outside of BitGo's system. 'custodial' means that this wallet is a cold wallet where BitGo owns the keys. Only customers of the BitGo Trust can create this kind of wallet. 'custodialPaired' means that this is a hot wallet that is owned by the customer but it will be linked to a cold (custodial) wallet where BitGo owns the keys. This option is only available to customers of BitGo Inc. BitGo stores an encrypted private key for the user key of 'hot' wallets. 'trading' wallets are trading accounts where the coin is 'ofc'. 'distributedCustody' means You manage one key and another key agent manages the second key. BitGo manages the third key
Comma-separated list of privileges for a wallet. Includes:
- 'admin' - Can manage wallet policies and users and approve or reject pending approvals.
- 'freeze' - Can freeze a wallet, disabling all withdrawals.
- 'spend' - Can initiate withdrawals and generate new receive addresses.
- 'trade' - Can initiate trades from a Go Account ('trading' wallet type).
- 'view' - Can view balances and transactions.
Permissions don't overlap. Required parameter if 'reshare' is false.
Allowed values: adminspendtradeview
Example: spend,view
customChangeKeySignaturesobject
Signatures for the keys which will be used to derive custom change addresses.
**Note:** These signatures may only be set once for each wallet and are not modifiable after being set.
userstring
backupstring
bitgostring
multisigTypestring
Allowed values: onchaintssblsdkg
multisigTypeVersionstring
Allowed value: MPCv2
balanceinteger
The total balance of all wallets containing the given coin type. May lose
precision for large values.
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
confirmedBalanceStringstring
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
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
stakedBalanceStringstring
String representation of 'stakedBalance'. Guaranteed to not lose
precision.
Example: 40000
tokensdictionary<string, object>
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.
object
unsupportedTokensdictionary<string, object>
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