> This page is for Taurus PROTECT, version v3.48.
> For other versions, use one of these documentation indexes:
> - v3.58 (default): https://taurushq.ferndocs.com/protect-capital/v3.58/llms.txt
> - v3.56: https://taurushq.ferndocs.com/protect-capital/v3.56/llms.txt
> - v3.54: https://taurushq.ferndocs.com/protect-capital/v3.54/llms.txt
> - v3.52: https://taurushq.ferndocs.com/protect-capital/v3.52/llms.txt
> - v3.50: https://taurushq.ferndocs.com/protect-capital/v3.50/llms.txt
> - v3.48: https://taurushq.ferndocs.com/protect-capital/v3.48/llms.txt
> - v3.46: https://taurushq.ferndocs.com/protect-capital/v3.46/llms.txt
> - v3.44: https://taurushq.ferndocs.com/protect-capital/v3.44/llms.txt
> - v3.42: https://taurushq.ferndocs.com/protect-capital/v3.42/llms.txt
> - v3.40: https://taurushq.ferndocs.com/protect-capital/v3.40/llms.txt
> - v3.38: https://taurushq.ferndocs.com/protect-capital/v3.38/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://taurushq.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://taurushq.ferndocs.com/_mcp/server.

# List wallets

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

This endpoint returns a list of wallets.

Reference: https://taurushq.ferndocs.com/protect-capital/reference/wallets/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `currencies` (list of string, optional) — Filter on IDs or symbols of the currency
- `query` (string, optional)
- `limit` (long, optional)
- `offset` (long, optional)
- `name` (string, optional) — Used to do a case insensitive partial wallet name match
- `sortOrder` (string, optional) — Set this parameter to ASC to get the addresses sorted in ascending order or DESC to get them in descending order.
- `excludeDisabled` (boolean, optional) — 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` (list of string, optional) — Filter wallets with a 'OR' combination of tag IDs
- `onlyPositiveBalance` (boolean, optional) — Whether or not to exclude wallets with a zero balance. Defaults to false (wallets with 0 balance included).
- `blockchain` (string, optional)
- `network` (string, optional)
- `ids` (list of string, optional) — An optional list of IDs. The list can't exceed 100 elements.

## Response

### 200

A successful response.

- `result` (list of tgvalidatordWalletInfo, optional)
- `totalItems` (string, optional)
- `offset` (string, optional) — The offset to get the next page.

## Errors

### 400 Bad Request Error

Bad 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)

- `any`

### 401 Unauthorized Error

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

- `any`

### 403 Forbidden Error

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

- `any`

### 404 Not Found Error

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

- `any`

### 500 Internal Server Error

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

- `any`

### 503 Service Unavailable Error

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

- `any`

## Types

### tgvalidatordWalletInfo

- `id` (string, optional)
- `balance` (tgvalidatordBalance, optional)
- `currency` (string, optional)
- `coin` (string, optional)
- `name` (string, optional)
- `container` (string, optional)
- `seed` (string, optional)
- `accountPath` (string, optional)
- `isOmnibus` (boolean, optional)
- `creationDate` (datetime, optional)
- `updateDate` (datetime, optional)
- `customerId` (string, optional)
- `comment` (string, optional)
- `disabled` (boolean, optional)
- `blockchain` (string, optional)
- `addressesCount` (string, optional)
- `currencyInfo` (tgvalidatordCurrency, optional)
- `attributes` (list of tgvalidatordWalletAttribute, optional)
- `network` (string, optional)
- `visibilityGroupID` (string, optional)
- `externalWalletId` (string, optional) — An optional external identifier for the wallet.

### tgvalidatordBalance

- `totalConfirmed` (string, optional) — Total confirmed balance in the smallest currency unit (e.g., WEI for ETH).
- `totalUnconfirmed` (string, optional) — Total balance including unconfirmed transactions in smallest currency unit (e.g., WEI). Exceeds totalConfirmed when transactions are pending confirmation. Equal to confirmed balance when all funds are confirmed.
- `availableConfirmed` (string, optional) — Available confirmed balance that is ready to be spent or used.
- `availableUnconfirmed` (string, optional) — Available balance including unconfirmed transactions.
- `reservedConfirmed` (string, optional) — Confirmed reserved balance that is set being held for specific purposes, such as another pending transactions.
- `reservedUnconfirmed` (string, optional) — Reserved unconfirmed balance that is not yet fully validated.

### tgvalidatordCurrency

- `name` (string, optional) — Name of the currency.
- `symbol` (string, optional) — Shorthand symbol for the currency.
- `coinTypeIndex` (string, optional) — Index used to identify the coin type in BIP44. (e.g. Bitcoin is 0, Ethereum is 60).
- `blockchain` (string, optional) — The Blockchain the currency is associated with, (e.g. ETH, BTC).
- `isToken` (boolean, optional) — Indicates if the currency is a token (e.g., ERC-20).
- `isERC20` (boolean, optional) — Indicates if the token is an ERC-20 token.
- `decimals` (string, optional) — Number of decimal places the currency uses (e.g. 18 for ETH).
- `contractAddress` (string, optional) — Smart contract address if currency is a smart contract (e.g. ERC-20.).
- `hasStaking` (boolean, optional) — Indicates if the currency supports staking.
- `isUTXOBased` (boolean, optional) — Indicates if the currency is UTXO-based (e.g. Bitcoin).
- `isAccountBased` (boolean, optional) — Indicates if the currency is account-based (e.g. Ethereum).
- `isFiat` (boolean, optional) — Indicates if the currency is a fiat currency (e.g. CHF, EUR, USD).
- `isFA12` (boolean, optional) — Indicates if the currency is based on FA12 standard (used in Tezos).
- `isFA20` (boolean, optional) — Indicates if the currency is based on FA20 standard (used in Tezos).
- `isNFT` (boolean, optional) — Indicates if the currency represents a Non-Fungible Token (NFT).
- `enabled` (boolean, optional) — Indicates if the currency is enabled in the current tenant.
- `id` (string, optional) — Unique identifier of the currency.
- `displayName` (string, optional) — Display name for the currency, (e.g. Ethereum, Bitcoin).
- `type` (string, optional) — Type of the currency. Can be `token`, `fiat`, `native` , or `signet`.
- `wlcaId` (string, optional) — White listed contract address id associated with the currency.
- `network` (string, optional) — Network or environment the currency is used on (e.g. 'mainnet', 'testnet').
- `tokenID` (string, optional) — Unique id for the token, if applicable (e.g. for NFTs).
- `logo` (string, optional) — Currency logo in Data URI scheme. Base 64 encoded. (e.g. data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==).

### tgvalidatordWalletAttribute

- `key` (string, optional)
- `value` (string, optional)
- `id` (string, optional)
- `contentType` (string, optional)
- `owner` (string, optional)
- `type` (string, optional)
- `subtype` (string, optional)
- `isfile` (boolean, optional)

## Examples

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your-protect-instance.example.com/api/rest/v2/wallets';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your-protect-instance.example.com/api/rest/v2/wallets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://your-protect-instance.example.com/api/rest/v2/wallets")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-protect-instance.example.com/api/rest/v2/wallets', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your-protect-instance.example.com/api/rest/v2/wallets");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your-protect-instance.example.com/api/rest/v2/wallets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```