> This page is for Taurus PROTECT, version v3.58 (default).
> 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.

# Get the balance, at wallet level, for a specific asset

POST https://your-protect-instance.example.com/api/rest/v1/asset/wallets
Content-Type: application/json

Retrieve the wallet level balance for a specific asset.
An asset is identified by the `currency` parameter.
Optionally, set `kind` to "NFT" or "Unknown" for additional filtering.
If `kind` is "Unknown", the "unknown" object can further filter balances by blockchain, arg1, and arg2 (e.g., blockchain, contract number, and token ID).

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

## Authentication

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

## Request

### Body (application/json)

This endpoint expects a tgvalidatordGetAssetWalletsRequest.

- `asset` (tgvalidatordAsset, required)
- `limit` (string, optional)
- `cursor` (string, optional)
- `walletId` (string, optional) — Filters for asset positions of a specific wallet
- `walletName` (string, optional)
- `requestCursor` (tgvalidatordRequestCursor, optional)

## Response

### 200

A successful response.

- `wallets` (list of tgvalidatordWalletInfo, optional)
- `totalItems` (string, optional)
- `next` (string, optional)
- `cursor` (tgvalidatordResponseCursor, optional)

## 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

### tgvalidatordAsset

- `currency` (string, required) — The currency name, e.g. 'ALGO', 'AVAX', 'USDt'. Set to 'Unknown' when the currency is unknown (as for the 'kind' field).
- `kind` (string, optional)
- `nft` (tgvalidatordAsset_NFT, optional)
- `unknown` (Asset_Unknown, optional)
- `currencyInfo` (tgvalidatordCurrency, optional)

### tgvalidatordRequestCursor

- `currentPage` (string, optional)
- `pageRequest` (string, optional)
- `pageSize` (string, optional)

### 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.

### tgvalidatordResponseCursor

- `currentPage` (string, optional)
- `hasPrevious` (boolean, optional) — Hints for UI to display whether a previous and/or next page of data are available.
- `hasNext` (boolean, optional)

### tgvalidatordAsset_NFT

- `tokenid` (string, optional)

### Asset_Unknown

- `blockchain` (string, optional)
- `arg1` (string, optional)
- `arg2` (string, optional)
- `network` (string, optional)

### 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) — DEPRECATED: use tokenInfo.tokenType == ERC20 instead.
- `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) — DEPRECATED: use tokenInfo.tokenType == FA12 instead.
- `isFA20` (boolean, optional) — DEPRECATED: use tokenInfo.tokenType == FA2 instead.
- `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==).
- `tokenInfo` (tgvalidatordTokenInfo, optional) — Token-specific details for a Currency. Present only when the currency is a token.

### 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.

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

### tgvalidatordTokenInfo

Token-specific details for a Currency. Present only when the currency is a token.

- `tokenType` (enum, optional) — Token standard of a currency; set only when it is a token. Replaces isERC20 (6), isFA12 (15), isFA20 (16).
  - Allowed values: `TOKEN_TYPE_ERC20`, `TOKEN_TYPE_ERC721`, `TOKEN_TYPE_ERC1155`, `TOKEN_TYPE_CRYPTO_PUNKS`, `TOKEN_TYPE_FA2`, `TOKEN_TYPE_FA12`, `TOKEN_TYPE_ASA`, `TOKEN_TYPE_COSMOS_BANK`, `TOKEN_TYPE_CW20`, `TOKEN_TYPE_XLM_ASSET`, `TOKEN_TYPE_SOL_TOKEN`, `TOKEN_TYPE_SOL_TOKEN_2022`, `TOKEN_TYPE_ICRC1`, `TOKEN_TYPE_HEDERA_TOKEN`, `TOKEN_TYPE_HEDERA_NFT`, `TOKEN_TYPE_CANTON_UTILITY`, `TOKEN_TYPE_TRC20`, `TOKEN_TYPE_CIP56`, `TOKEN_TYPE_XRP_ASSET`

## Examples

**Request**

```json
{
  "asset": {
    "currency": "string"
  }
}
```

**Response**

```json
{
  "wallets": [
    {
      "id": "string",
      "balance": {
        "totalConfirmed": "string",
        "totalUnconfirmed": "string",
        "availableConfirmed": "string",
        "availableUnconfirmed": "string",
        "reservedConfirmed": "string",
        "reservedUnconfirmed": "string"
      },
      "currency": "string",
      "coin": "string",
      "name": "string",
      "container": "string",
      "seed": "string",
      "accountPath": "string",
      "isOmnibus": true,
      "creationDate": "2024-01-15T09:30:00Z",
      "updateDate": "2024-01-15T09:30:00Z",
      "customerId": "string",
      "comment": "string",
      "disabled": true,
      "blockchain": "string",
      "addressesCount": "string",
      "currencyInfo": {
        "name": "string",
        "symbol": "string",
        "coinTypeIndex": "string",
        "blockchain": "string",
        "isToken": true,
        "isERC20": true,
        "decimals": "string",
        "contractAddress": "string",
        "hasStaking": true,
        "isUTXOBased": true,
        "isAccountBased": true,
        "isFiat": true,
        "isFA12": true,
        "isFA20": true,
        "isNFT": true,
        "enabled": true,
        "id": "string",
        "displayName": "string",
        "type": "string",
        "wlcaId": "string",
        "network": "string",
        "tokenID": "string",
        "logo": "string",
        "tokenInfo": {
          "tokenType": "TOKEN_TYPE_ERC20"
        }
      },
      "attributes": [
        {
          "key": "string",
          "value": "string",
          "id": "string",
          "contentType": "string",
          "owner": "string",
          "type": "string",
          "subtype": "string",
          "isfile": true
        }
      ],
      "network": "string",
      "visibilityGroupID": "string",
      "externalWalletId": "string"
    }
  ],
  "totalItems": "string",
  "next": "string",
  "cursor": {
    "currentPage": "string",
    "hasPrevious": true,
    "hasNext": true
  }
}
```

**SDK Code**

```python
import requests

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

payload = { "asset": { "currency": "string" } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your-protect-instance.example.com/api/rest/v1/asset/wallets';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"asset":{"currency":"string"}}'
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"asset\": {\n    \"currency\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/v1/asset/wallets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"asset\": {\n    \"currency\": \"string\"\n  }\n}"

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.post("https://your-protect-instance.example.com/api/rest/v1/asset/wallets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"asset\": {\n    \"currency\": \"string\"\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-protect-instance.example.com/api/rest/v1/asset/wallets', [
  'body' => '{
  "asset": {
    "currency": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/asset/wallets");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"asset\": {\n    \"currency\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["asset": ["currency": "string"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

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

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()
```