latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Wallet

Get wallets count

Get a count of all wallets you can access, 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.

You can use this endpoint in conjunction with the <b>List wallets</b> endpoint to enable paginating a list of wallets. For example, once you get the wallets count, you can use the total count to calculate the number of pages you need in order to display all the wallets.

get/api/v2/wallets/count

Query parameters

idstring[]

Filter by ID.

[
  "59cd72485007a239fb00282ed480da1f"
]
coinstring[]

Filter by coin

[
  "btc"
]
enterprisestring[]

Filter by enterprise

[
  "59cd72485007a239fb00282ed480da1f"
]
typestring[]

Filter by wallet type.

deletedboolean

Filter by deleted state.

labelContainsstring

Filter by label substring

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

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

countnumber required

The number of wallets that match the query.