Generic get wallets route

get/api/v2/admin/wallets

Query Parameters

  • enterpriseIdsarray[string]
    array of enterprise ids to fetch the wallets of
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • userIdsarray[string]
    array of user ids to fetch the wallets of
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • walletIdsarray[string]
    array of wallet ids to fetch
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • coinsListarray[string]
    array of coins to fetch wallets of
    Example: btc
  • typestring
    wallet type
    Enum: cold custodial custodialPaired hot trading distributedCustody advanced
  • getAllTrustWalletsboolean
    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 Inc BitGo Trust BitGo New York BitGo Germany BitGo Switzerland Frankfurt DE Trust BitGo Sister Trust 1 BitGo Korea BitGo Singapore BitGo Europe ApS BitGo Mena Fze BitGo Custody MENA FZE BitGo 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: next prev

200 Response

wallets array[object]
admin object
allowBackupKeySigning boolean
approvalsRequired integer required
Minimum: >= 1
Example: 1
balanceString string
Total balance in base units (e.g. Satoshis)
Example: 2000000
Match pattern: ^-?\d+$
buildDefaults object
coin string required
A cryptocurrency or token ticker symbol.
Example: btc
coinSpecificOne of
custodialWallet object
The associated custodial wallet object
custodialWalletId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
deleted boolean required
disableTransactionNotifications boolean required
enterprise string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
freeze object
id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
isCold boolean
keys array[string]
Example: 59cd72485007a239fb00282ed480da1f
label string required
Example: My Wallet
m integer
Number of signatures required. This value must be 2 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 2
n integer
Number of keys provided. This value must be 3 for hot wallets, 1 for **ofc** wallets, and not specified for custodial wallets.
Example: 3
nodeId string
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
receiveAddress object
recoverable boolean
tags array[string]
Example: 59cd72485007a239fb00282ed480da1f
spendableBalanceString string
Spendable balance in base units (e.g. Satoshis)
Example: 2000000
Match pattern: ^-?\d+$
unspentCount number
Number of unspent outputs present in the wallet
Example: 100
startDate string <date-time>
Wallet creation time
Example: {}
type string
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
Allowed values: cold custodial custodialPaired hot trading distributedCustody advanced
users array[object]
Example: {"user":"55e8a1a5df8380e0e30e20c6","permissions":["admin","view","spend"]}
customChangeKeySignatures object
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.
multisigType string
Allowed values: onchain tss blsdkg
multisigTypeVersion string
Allowed value: MPCv2
nextCursor string
(Optional) The next cursor to use for pagination if next page is available and pagination is used
prevCursor string
(Optional) The previous cursor to use for pagination if previous page is available and pagination is used
hasMore boolean
(Optional) Indicates if there are more pages available in next direction

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