> This page is for Taurus PROTECT, version v3.38. > 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 addresses GET https://your-protect-instance.example.com/api/rest/v1/addresses This endpoint returns a list of addresses Reference: https://taurushq.ferndocs.com/protect-capital/reference/addresses/list ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `currency` (string, optional) — Filter on IDs or symbols of the currency - `query` (string, optional) - `limit` (long, optional) - `offset` (long, optional) - `scoreProvider` (string, optional) — Deprecated. Use scoreFilter instead. - `scoreInBelow` (string, optional) — Deprecated. Use scoreFilter instead. - `scoreOutBelow` (string, optional) — Deprecated. Use scoreFilter instead. - `scoreExclusive` (boolean, optional) — Deprecated. Use scoreFilter instead. - `onlyPositiveBalance` (boolean, optional) — Set this parameter to true to get only addresses with a positive unconfirmed balance - `sortBy` (string, optional) — Set this parameter to select the type on which you want to sort.The types accepted yet are: BALANCE and ADDRESSID - `sortOrder` (string, optional) — Set this parameter to ASC to get the addresses sorted in ascending order or DESC to get them in descending order. - `balanceBelow` (string, optional) — Filter addresses and keep only addresses with a balance below the threshold. - `balanceAbove` (string, optional) — Filter addresses and keep only addresses with a balance above the threshold. - `walletId` (string, optional) - `customerId` (string, optional) - `coinfirmScoreGreater` (string, optional) — Deprecated. Use scoreFilter instead. - `chainalysisScoreGreater` (string, optional) — Deprecated. Use scoreFilter instead. - `tagIDs` (list of string, optional) — Filter addresses with a 'OR' combination of tag IDs - `blockchain` (string, optional) - `network` (string, optional) - `addressIds` (list of string, optional) — Filter addresses with a list of address IDs. - `nfts` (string, optional) — One of include / exclude / only depending on whether you want to include addresses of type NFTs (or you want only those) - `addresses` (list of string, optional) — Filter addresses with a list of blockchain addresses (hashes).The blockchain needs to be specified when using this filter. - `scoreFilter.scoreProvider` (string, optional) — Specify the score provider to filter on, or empty.Each provider has associated filter parameters that can be set.Supported values: 'scorechain', 'coinfirm', 'chainalysis', 'elliptic', 'trmlabs' - `scoreFilter.scorechainFilters.scoreInBelow` (string, optional) — Filter addresses under a Scorechain incoming score threshold. - `scoreFilter.scorechainFilters.scoreOutBelow` (string, optional) — Filter addresses under a Scorechain outgoing score threshold. - `scoreFilter.scorechainFilters.scoreExclusive` (boolean, optional) — By default when both Scorechain scores scoreInBelow and scoreOutBelow are provided, it returns the addresses matching (scoreInBelow AND scoreOutBelow). When scoreExclusive is set to true, it will return the addresses matching (scoreInBelow OR scoreOutBelow). - `scoreFilter.coinfirmFilters.scoreGreater` (string, optional) — Filter addresses with a Coinfirm C-score above threshold. - `scoreFilter.chainalysisFilters.scoreGreater` (string, optional) — Filter addresses with a Chainalysis risk score above threshold. - `scoreFilter.ellipticFilters.scoreGreater` (string, optional) — Filter addresses with an Elliptic risk score above threshold. - `scoreFilter.trmlabsFilters.scoreGreater` (string, optional) — Filter addresses with an TRM Labs risk score above threshold. - `attributeFiltersJson` (string, optional) — A JSON representation of a list of AttributeFilter objects. The filters are combined with an OR operator.Example: \[\{'key':'key1','value':'value1','type':'type1'},\{'key':'key2','value':'value2'}] ## Response ### 200 A successful response. - `result` (list of tgvalidatordAddress, optional) - `totalItems` (string, 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 ### tgvalidatordAddress - `id` (string, optional) - `walletId` (string, optional) - `seed` (string, optional) - `currency` (string, optional) - `addressPath` (string, optional) - `addressIndex` (string, optional) - `address` (string, optional) - `alternateAddress` (string, optional) - `comment` (string, optional) - `label` (string, optional) - `customerId` (string, optional) - `nonce` (string, optional) - `balance` (tgvalidatordBalance, optional) — Balance in the smallest currency unit. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH - `signature` (string, optional) - `scores` (list of tgvalidatordScore, optional) - `attributes` (list of tgvalidatordAddressAttribute, optional) - `linkedWhitelistedAddressIds` (list of string, optional) - `creationDate` (datetime, optional) - `updateDate` (datetime, optional) - `walletInfo` (tgvalidatordWalletInfo, optional) - `disabled` (boolean, optional) - `currencyInfo` (tgvalidatordCurrency, optional) - `canUseAllFunds` (boolean, optional) - `externalAddressId` (string, optional) ### tgvalidatordBalance Balance in the smallest currency unit. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH - `totalConfirmed` (string, optional) - `totalUnconfirmed` (string, optional) - `availableConfirmed` (string, optional) - `availableUnconfirmed` (string, optional) - `reservedConfirmed` (string, optional) - `reservedUnconfirmed` (string, optional) ### tgvalidatordScore - `id` (string, optional) - `provider` (string, optional) - `type` (string, optional) - `score` (string, optional) - `updateDate` (datetime, optional) ### tgvalidatordAddressAttribute - `key` (string, optional) - `value` (string, optional) - `id` (string, optional) - `contentType` (string, optional) - `owner` (string, optional) - `type` (string, optional) - `subtype` (string, optional) - `isfile` (boolean, optional) ### tgvalidatordWalletInfo - `id` (string, optional) - `balance` (tgvalidatordBalance, optional) — Balance in the smallest currency unit. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH - `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) ### tgvalidatordCurrency - `name` (string, optional) - `symbol` (string, optional) - `coinTypeIndex` (string, optional) - `blockchain` (string, optional) - `isToken` (boolean, optional) - `isERC20` (boolean, optional) - `decimals` (string, optional) - `contractAddress` (string, optional) - `hasStaking` (boolean, optional) - `isUTXOBased` (boolean, optional) - `isAccountBased` (boolean, optional) - `isFiat` (boolean, optional) - `isFA12` (boolean, optional) - `isFA20` (boolean, optional) - `isNFT` (boolean, optional) - `enabled` (boolean, optional) - `id` (string, optional) - `displayName` (string, optional) - `type` (string, optional) - `wlcaId` (string, optional) - `network` (string, optional) - `tokenID` (string, optional) - `logo` (string, optional) — Data URI Scheme (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": "string", "walletId": "string", "seed": "string", "currency": "string", "addressPath": "string", "addressIndex": "string", "address": "string", "alternateAddress": "string", "comment": "string", "label": "string", "customerId": "string", "nonce": "string", "balance": { "totalConfirmed": "1500000000000000000", "totalUnconfirmed": "100000", "availableConfirmed": "1500000000000000000", "availableUnconfirmed": "100000" }, "signature": "string", "scores": [ { "id": "string", "provider": "string", "type": "string", "score": "string", "updateDate": "2024-01-15T09:30:00Z" } ], "attributes": [ { "key": "string", "value": "string", "id": "string", "contentType": "string", "owner": "string", "type": "string", "subtype": "string", "isfile": true } ], "linkedWhitelistedAddressIds": [ "string" ], "creationDate": "2024-01-15T09:30:00Z", "updateDate": "2024-01-15T09:30:00Z", "walletInfo": { "id": "string", "balance": { "totalConfirmed": "1500000000000000000", "totalUnconfirmed": "100000", "availableConfirmed": "1500000000000000000", "availableUnconfirmed": "100000" }, "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" }, "attributes": [ { "key": "string", "value": "string", "id": "string", "contentType": "string", "owner": "string", "type": "string", "subtype": "string", "isfile": true } ], "network": "string", "visibilityGroupID": "string" }, "disabled": true, "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" }, "canUseAllFunds": true, "externalAddressId": "string" } ], "totalItems": "string" } ``` **SDK Code** ```python import requests url = "https://your-protect-instance.example.com/api/rest/v1/addresses" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://your-protect-instance.example.com/api/rest/v1/addresses'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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/v1/addresses" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/addresses") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://your-protect-instance.example.com/api/rest/v1/addresses") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://your-protect-instance.example.com/api/rest/v1/addresses', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/addresses"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://your-protect-instance.example.com/api/rest/v1/addresses")! 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() ```