Ctrl+K

Get wallets count

get/api/v2/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 List wallets 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.

Query Parameters

  • idarray[string]
    Filter by ID.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters
  • coinarray[string]
    Filter by coin
    Example: btc
  • enterprisearray[string]
    Filter by enterprise
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • typearray[string]
    Filter by wallet type.
    Enum: backing cold custodial custodialPaired hot trading
  • deletedboolean
    Filter by deleted state.
  • labelContainsstring
    Filter by label substring
  • bitgoOrgstring
    Return only wallets belong to the BitGo trust org
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo Sister Trust 1

200 Response

count number required
The number of wallets that match the query.
Minimum: >= 0

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id