pass this if you want all trust wallets, overrides id params, requires bitgoOrg
ignoreBalancesboolean
pass this if you do not care about the balances, skips expensive ims calls
includeDeletedboolean
pass this if you want to return deleted wallets
bitgoOrgstring
Filter by bitgoOrg
Enum: BitGo IncBitGo TrustBitGo New YorkBitGo GermanyBitGo SwitzerlandFrankfurt DE TrustBitGo Sister Trust 1BitGo KoreaBitGo SingaporeBitGo Europe ApSBitGo Mena FzeBitGo Custody MENA FZEBitGo India
walletLabelRegexstring
Regular expression to match wallet labels
usePaginatedWalletQueryboolean
Boolean to indicate if pagination is to be used
limitnumberDefault: 10
number of wallets to return [default/min=10 , max = 25]
Minimum: >= 10
Maximum: <= 25
cursorstring
The last wallet.id from the previous result set in case of Next page, and the first wallet.id from the previous result set in case of Previous page.
directionstring
The direction of the pagination. Can be either 'next' or 'prev'.
Enum: nextprev
200 Response
walletsarray[object]
adminobject
allowBackupKeySigningboolean
approvalsRequiredintegerrequired
Minimum: >= 1
Example: 1
balanceStringstring
Total balance in base units (e.g. Satoshis)
Example: 2000000
Match pattern: ^-?\d+$
buildDefaultsobject
coinstringrequired
A cryptocurrency or token ticker symbol.
Example: btc
coinSpecificOne of
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
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
recoverableboolean
tagsarray[string]
Example: 59cd72485007a239fb00282ed480da1f
spendableBalanceStringstring
Spendable balance in base units (e.g. Satoshis)
Example: 2000000
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
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.
multisigTypestring
Allowed values: onchaintssblsdkg
multisigTypeVersionstring
Allowed value: MPCv2
nextCursorstring
(Optional) The next cursor to use for pagination if next page is available and pagination is used
prevCursorstring
(Optional) The previous cursor to use for pagination if previous page is available and pagination is used
hasMoreboolean
(Optional) Indicates if there are more pages available in next direction