List wallets

GET

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

GET

/api/rest/v2/wallets

curl https://your-protect-instance.example.com/api/rest/v2/wallets \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "1",
      "balance": {
        "totalConfirmed": "5735335",
        "totalUnconfirmed": "5735335",
        "availableConfirmed": "47147",
        "availableUnconfirmed": "47147",
        "reservedConfirmed": "5688188",
        "reservedUnconfirmed": "5688188"
      },
      "currency": "BTC",
      "coin": "BTC",
      "name": "nostro",
      "container": "",
      "seed": "btc",
      "accountPath": "m/44'/0'/0'",
      "isOmnibus": true,
      "creationDate": "2019-01-31T15:58:48.645369Z",
      "updateDate": "2022-01-12T09:45:19.981071Z",
      "blockchain": "BTC",
      "addressesCount": "48"
    },
    {
      "id": "2",
      "balance": {
        "totalConfirmed": "418185",
        "totalUnconfirmed": "418185",
        "availableConfirmed": "418185",
        "availableUnconfirmed": "418185",
        "reservedConfirmed": "0",
        "reservedUnconfirmed": "0"
      },
      "currency": "BTC",
      "coin": "BTC",
      "name": "nostro",
      "container": "",
      "seed": "btc",
      "accountPath": "m/44'/0'/1'",
      "isOmnibus": true,
      "creationDate": "2019-01-31T15:58:48.645369Z",
      "updateDate": "2022-01-12T09:45:19.981071Z",
      "blockchain": "BTC",
      "addressesCount": "43"
    },
    {}
  ],
  "totalItems": "27"
}

This endpoint returns a list of wallets.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

currencieslist of stringsOptional

Filter on IDs or symbols of the currency

querystringOptional

limitlongOptional

offsetlongOptional

namestringOptional

Used to do a case insensitive partial wallet name match

sortOrderstringOptional

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

excludeDisabledbooleanOptional

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.

tagIDslist of stringsOptional

Filter wallets with a 'OR' combination of tag IDs

onlyPositiveBalancebooleanOptional

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

blockchainstringOptional

networkstringOptional

idslist of stringsOptional

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

includeUntaggedstringOptional

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"

Response

A successful response.

resultlist of objectsOptional

totalItemsstringOptionalformat: "uint64"

offsetstringOptionalformat: "uint64"

The offset to get the next page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error