> 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 reserved funds GET https://your-protect-instance.example.com/api/rest/v1/reservations This endpoint returns a list of fund reservations. Default limit is 100. Results are sorted by the most recent reservations first. Reference: https://taurushq.ferndocs.com/protect-capital/reference/reservations/list ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `kind` (string, optional) — Deprecated since 3.20: use 'kinds' instead. - `address` (string, optional) — Filter by blockchain address - `addressId` (string, optional) — Filter by address id - `cursor.currentPage` (string, optional) — Base64-encoded string representing the current window of data - `cursor.pageRequest` (string, optional) — The page to request, w.r.t the current page. Can be one of `FIRST`, `PREVIOUS`, `NEXT`, `LAST` - `cursor.pageSize` (string, optional) — The size of the page requested. The handling service should impose a hard limit on this - `kinds` (list of string, optional) — Filter by kinds of reservation. Takes precedence over 'kind'. ## Response ### 200 A successful response. - `result` (list of tgvalidatordReservation, 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 ### tgvalidatordReservation - `id` (string, optional) - `amount` (string, optional) - `creationDate` (datetime, optional) - `kind` (string, optional) — The kind of reservation. - `comment` (string, optional) — Comment about the reservation. Can be absent. - `addressid` (string, optional) — References the internal address stored in protect. Can be absent. - `address` (string, optional) — The blockchain address string/hash - `currencyInfo` (tgvalidatordCurrency, optional) - `asset` (tgvalidatordAsset, optional) - `resourceId` (string, optional) — The resource id associated with the reservation - `resourceType` (string, optional) — The resource type associated with the reservation ### 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) ### 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==') ### tgvalidatordAsset - `currency` (string, required) - `kind` (string, optional) - `nft` (tgvalidatordAsset_NFT, optional) - `unknown` (Asset_Unknown, optional) - `currencyInfo` (tgvalidatordCurrency, optional) ### tgvalidatordAsset_NFT - `tokenid` (string, optional) ### Asset_Unknown - `blockchain` (string, optional) - `arg1` (string, optional) - `arg2` (string, optional) - `network` (string, optional) ## Examples **Response** ```json { "result": [ { "id": "string", "amount": "string", "creationDate": "2024-01-15T09:30:00Z", "kind": "string", "comment": "string", "addressid": "string", "address": "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" }, "asset": { "currency": "string", "kind": "string", "nft": { "tokenid": "string" }, "unknown": { "blockchain": "string", "arg1": "string", "arg2": "string", "network": "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" } }, "resourceId": "string", "resourceType": "string" } ], "cursor": { "currentPage": "string", "hasPrevious": true, "hasNext": true } } ``` **SDK Code** ```python import requests url = "https://your-protect-instance.example.com/api/rest/v1/reservations" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://your-protect-instance.example.com/api/rest/v1/reservations'; 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/reservations" 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/reservations") 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/reservations") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://your-protect-instance.example.com/api/rest/v1/reservations', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/reservations"); 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/reservations")! 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() ```