Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

List wallets

Lists all wallets you can access when the enterprise ID is provided, including:

  • Wallets you have a role on (admin, spender, or viewer).
  • Wallets in enterprises you belong to that have the View All Wallets option enabled from the enterprise settings.

If the enterprise ID is not provided, lists only the wallets you have a role on.

get/api/v2/wallets

Query parameters

idstring[]

Filter by ID

[
  "\"59cd72485007a239fb00282ed480da1f\""
]
coinstring[]

Filter by coin

[
  "\"btc\""
]
enterprisestring[]

Filter by enterprise.

[
  "\"59cd72485007a239fb00282ed480da1f\""
]
typestring[]

Filter by wallet type

subTypestring[]

Filter by wallet sub-type

deletedboolean

Filter by deleted state

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.

labelContainsstring

Filter by label substring.

expandBalanceboolean

Add "balanceString", "confirmedBalanceString" and "spendableBalanceString" to each wallet

excludeSpendableBalanceboolean
expandPolicyboolean
expandCustodialWalletboolean

Whether linked custodial wallets should be expanded inline

ignoreErrorsboolean
includeStakingBalancesboolean

Include stakingBalanceString and rewardBalanceString properties for each staking wallet. Requires expandBalance to be set to true.

limitstring number

Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.

offsetstring number

Number of documents to skip for offset-based pagination.

skipReceiveAddressboolean

Do not add "receiveAddress" to each wallet

permission'admin' | 'view' | 'spend'

Return only wallets for which the user has the given permission

pinnedWallets'pinnedOnly' | 'pinnedExcluded'

Return only pinned wallets ("pinnedOnly") or only unpinned wallets ("pinnedExcluded"), exclude to return both

bitgoOrg'BitGo Trust' | 'BitGo New York' | 'BitGo Germany' | 'BitGo Switzerland' | 'BitGo Europe ApS' | 'Frankfurt DE Trust' | 'BitGo Singapore' | 'BitGo Korea' | 'BitGo Custody MENA FZE' | 'BitGo India' | 'BitGo Sister Trust 1'

Return only wallets belong to the BitGo trust org

skipUnsupportedCoinsboolean

Skip unsupported coins instead of returning an error

customTagsstring[]

Filter wallets by applied tags (OR semantics). Provide one or more tag values; returns wallets that match any of the supplied tags. Tag matching is case-insensitive — ?customTags=Warm matches stored "warm".

[
  "\"warm\""
]

Response

OK

nextBatchPrevIdstring uuid

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the "prevId" query parameter.

totalCountnumber