List wallets

get

https://your-protect-instance.example.com/api/rest/v2/wallets

This endpoint returns a list of wallets.

Query Params

currencies

array of strings

Filter on IDs or symbols of the currency

currencies

query

string

limit

string

offset

string

name

string

Used to do a case insensitive partial wallet name match

sortOrder

string

Set this parameter to ASC to get the addresses sorted in ascending order or DESC to get them in descending order.

excludeDisabled

boolean

Whether or not to exclude wallets disabled by business rules. Defaults to false (disabled wallets included). Filtering will be performed after pagination, i.e. the number of returned items may be below limit if wallets on a page are disabled.

tagIDs

array of strings

Filter wallets with a 'OR' combination of tag IDs

tagIDs

onlyPositiveBalance

boolean

Whether or not to exclude wallets with a zero balance. Defaults to false (wallets with 0 balance included).

blockchain

string

network

string

ids

array of strings

An optional list of IDs. The list can't exceed 100 elements.

ids

includeUntagged

string

One of [exclude, include, only] depending on whether you want to include untagged wallets (or you want only those). Optional field with default value as "include"

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.