> This page is for Taurus PROTECT, version v3.54. > 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 transactions GET https://your-protect-instance.example.com/api/rest/v1/transactions This endpoint returns a list of transactions based on the provided query parameters. You must specify either a `currency` (by ID or symbol) or a combination of `blockchain` and `network`. - If `currency` is provided, `blockchain` and `network` cannot be used. - If `currency` is not provided, you may use `blockchain`, `network`, or both together. Only one of these approaches is allowed per request. The `currencyID` is unique across blockchains and networks, and can be identified by querying the `/currencies` endpoint. We recommend using `currencyID` whenever possible to avoid ambiguity. Reference: https://taurushq.ferndocs.com/protect-capital/reference/transactions/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 ID or symbol of the currency - `direction` (string, optional) — The direction of the transaction (e.g. `incoming`, `outgoing`) - `query` (string, optional) — Filter by query string in any of the fields address, customerid, transactionid, hash, type. - `limit` (long, optional) — The amount of transactions returned per request. Max 100. - `offset` (long, optional) — The offset from which to begin selection of transactions. - `from` (datetime, optional) — Only return transactions from after this timestamp. - `to` (datetime, optional) — Only return transactions from before this timestamp. - `transactionIds` (list of string, optional) — Filter on Protect internal transactionID. This is purely internal and should rarely be used by clients - `type` (string, optional) — The type of transactions to fetch (e.g. `burn`). - `source` (string, optional) — Returns only transaction that have this address as a source - `destination` (string, optional) — Returns only transaction that have this address as a destination - `ids` (list of string, optional) — Filter on Protect transaction ID, as visible in the transaction objects. - `blockchain` (string, optional) — The blockchain associated with the transactions (e.g. `ETH`, `BTC`) - `network` (string, optional) — The network the transaction took place in (e.g. `mainnet`, `testnet`). - `fromBlockNumber` (string, optional) — Only return transactions from after this block. - `toBlockNumber` (string, optional) — Only return transactions from before this block. - `hashes` (list of string, optional) — Filter on transaction hash, as visible in the transaction objects. - `address` (string, optional) — Returns only transaction that have this address as either a source or a destination - `amountAbove` (string, optional) — Returns only transactions with an amount strictly above the given amount - `excludeUnknownSourceDestination` (boolean, optional) — Returns only transactions with a known source and destination, default false - `customerId` (string, optional) — Returns only transactions with a specific customer id ## Response ### 200 A successful response. - `result` (list of tgvalidatordTransaction, optional) - `totalItems` (string, optional) — The total number of transactions. ## 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 ### tgvalidatordTransaction - `id` (string, optional) — A unique identifier for the transaction - `direction` (string, optional) — The direction of the transaction (e.g. `incoming`, `outgoing`) - `currency` (string, optional) — The symbol or unique id of the currency the transaction used (e.g. `ETH`) - `sources` (list of tgvalidatordAddressInfo, optional) — The addresses that sent currency for this transaction. - `destinations` (list of tgvalidatordAddressInfo, optional) — The addresses that received currency for this transaction. - `amount` (string, optional) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `amountMainUnit` (string, optional) — Amount in the main currency unit (e.g. A BTC transaction will use the BTC value here instead of SAT) - `fee` (string, optional) — The fee associated with the transaction if there is one. In the smallest currency unit. - `feeMainUnit` (string, optional) — The fee associated with the transaction if there is one. In the main currency unit. - `hash` (string, optional) — The hash of the transaction as returned by the chain. - `block` (string, optional) — The block number associated with the transaction. - `receptionDate` (datetime, optional) — When the transaction was received by the blockchain. - `confirmationDate` (datetime, optional) — When the transaction was fully confirmed. - `transactionId` (string, optional) — An id for the transaction. - `type` (string, optional) — The type of transaction occurring (e.g. `burn`, `approve`). - `uniqueId` (string, optional) — A unique id for the transaction. - `blockchain` (string, optional) — The blockchain associated with the transaction (e.g. `ETH`, `BTC`) - `arg1` (string, optional) — If set, serves as a sub-identifier to the blockchain field for the type of resource this transaction relates to. Typically a contract address. - `arg2` (string, optional) — If set, serves as a sub-identifier to the arg1 field for the type of resource this transaction relates to. Typically a token ID. - `currencyInfo` (tgvalidatordCurrency, optional) - `network` (string, optional) — The network the transaction took place in (e.g. `mainnet`, `testnet`). - `requestId` (string, optional) — If set, contains the request ID that this transaction originated from. - `confirmationBlock` (string, optional) — The block that the transaction was confirmed by. - `requestVisible` (boolean, optional) — Indicates whether the requestId value refers to a request that is visible to the user. - `travelRule` (tgvalidatordTravelRule, optional) - `status` (string, optional) — The current status of the transaction, [`NEW`, `SUCCESS`, `PENDING`, `TEMPORARY_FAILURE`, `INVALID`, `TIMEOUT`, `MINED`, `LOST`, `EXPIRED`] - `platformFees` (list of tgvalidatordPlatformFee, optional) — Any Platform fees on the transaction such as exchange withdrawals. - `attributes` (list of tgvalidatordTransactionAttribute, optional) — A list of key-value transaction attributes. - `forkNumber` (string, optional) — The forkNumber is used in case a blockchain uses a new platform and starts over with a new genesis hash. For instance it is set to 1 on the new DOT AssetHub platform, otherwise it is 0 in most cases. - `fees` (list of tgvalidatordTransactionFees, optional) — List of the fees of the transaction with corresponding assets. - `isConfirmed` (boolean, optional) — True if the transaction is fully confirmed, false otherwise. ### tgvalidatordAddressInfo - `address` (string, optional) - `label` (string, optional) — Label of the address if it is known to Taurus-PROTECT (i.e. if it's an internal or a whitelisted address) - `container` (string, optional) - `customerId` (string, optional) - `amount` (string, optional) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `amountMainUnit` (string, optional) - `type` (string, optional) — The type of the transaction element (one of source or destination) - `idx` (string, optional) - `internalAddressId` (string, optional) — ID of the internal address, if the address is an internal one. Otherwise this field is left empty (or 0) - `whitelistedAddressId` (string, optional) — ID of the whitelisted address, if the address is an whitelisted one. Otherwise this field is left empty (or 0) - `scores` (list of tgvalidatordTransactionScore, optional) — Transaction scores related to this address (only for destinations). Up to one score per [KYT provider, score type]. ### 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==). ### tgvalidatordTravelRule - `originatorPersonTravelRuleData` (tgvalidatordPersonTravelRuleData, optional) - `originatorCompanyTravelRuleData` (tgvalidatordCompanyTravelRuleData, optional) - `beneficiaryCompanyTravelRuleData` (tgvalidatordCompanyTravelRuleData, optional) - `beneficiaryPersonTravelRuleData` (tgvalidatordPersonTravelRuleData, optional) - `currency` (string, optional) — The symbol or unique id of the associated currency (e.g. `ETH`) - `amount` (string, optional) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `amountMainUnit` (string, optional) — Amount in the main currency unit (e.g. A BTC transaction will use the BTC value here instead of SAT) - `transactionHash` (string, optional) - `originatorParticipant` (string, optional) - `beneficiaryParticipant` (string, optional) - `initiationDate` (datetime, optional) - `confirmationDate` (datetime, optional) - `blockchain` (string, optional) — The identifier of the associated blockchain (e.g. `ETH`, `BTC`) - `network` (string, optional) — The associated network (e.g. `mainnet`, `testnet`). ### tgvalidatordPlatformFee - `type` (string, optional) — The fee type. This can only be "exchange", but other types may be added in the future. - `amount` (string, optional) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `amountMainUnit` (string, optional) — Amount in the main currency unit (e.g. A BTC transaction will use the BTC value here instead of SAT) - `symbol` (string, optional) — The symbol returned with the fee amount if provided. ### tgvalidatordTransactionAttribute - `id` (string, optional) - `key` (string, optional) - `value` (string, optional) ### tgvalidatordTransactionFees - `asset` (tgvalidatordAsset, optional) - `fees` (list of tgvalidatordTransactionFee, optional) ### tgvalidatordTransactionScore - `id` (string, optional) - `provider` (string, optional) - `type` (string, optional) - `score` (string, optional) - `updateDate` (datetime, optional) ### tgvalidatordPersonTravelRuleData - `name` (string, optional) - `houseNumber` (string, optional) - `street` (string, optional) - `city` (string, optional) - `province` (string, optional) - `postalCode` (string, optional) - `country` (string, optional) - `idNumber` (string, optional) - `externalCustomerID` (string, optional) - `birthdate` (string, optional) - `birthPlace` (string, optional) - `accountNumber` (string, optional) ### tgvalidatordCompanyTravelRuleData - `department` (string, optional) - `buildingNumber` (string, optional) - `street` (string, optional) - `city` (string, optional) - `province` (string, optional) - `postalCode` (string, optional) - `country` (string, optional) - `legalEntityIdentifier` (string, optional) - `businessName` (string, optional) - `accountNumber` (string, optional) ### 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) ### tgvalidatordTransactionFee - `type` (string, optional) - `amount` (string, optional) — Amount in the smallest currency unit, based on the currency decimals. Example: 1500000000000000000 WEI (smallest ETH unit) corresponds to 1.5 ETH (ETH has 18 decimals places) - `amountMainUnit` (string, optional) — Amount in the main currency unit (e.g. A BTC transaction will use the BTC value here instead of SAT) ### 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", "direction": "string", "currency": "string", "sources": [ { "address": "string", "label": "string", "container": "string", "customerId": "string", "amount": "string", "amountMainUnit": "string", "type": "string", "idx": "string", "internalAddressId": "string", "whitelistedAddressId": "string", "scores": [ { "id": "string", "provider": "string", "type": "string", "score": "string", "updateDate": "2024-01-15T09:30:00Z" } ] } ], "destinations": [ { "address": "string", "label": "string", "container": "string", "customerId": "string", "amount": "string", "amountMainUnit": "string", "type": "string", "idx": "string", "internalAddressId": "string", "whitelistedAddressId": "string", "scores": [ { "id": "string", "provider": "string", "type": "string", "score": "string", "updateDate": "2024-01-15T09:30:00Z" } ] } ], "amount": "string", "amountMainUnit": "string", "fee": "string", "feeMainUnit": "string", "hash": "string", "block": "string", "receptionDate": "2024-01-15T09:30:00Z", "confirmationDate": "2024-01-15T09:30:00Z", "transactionId": "string", "type": "string", "uniqueId": "string", "blockchain": "string", "arg1": "string", "arg2": "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" }, "network": "string", "requestId": "string", "confirmationBlock": "string", "requestVisible": true, "travelRule": { "originatorPersonTravelRuleData": { "name": "string", "houseNumber": "string", "street": "string", "city": "string", "province": "string", "postalCode": "string", "country": "string", "idNumber": "string", "externalCustomerID": "string", "birthdate": "string", "birthPlace": "string", "accountNumber": "string" }, "originatorCompanyTravelRuleData": { "department": "string", "buildingNumber": "string", "street": "string", "city": "string", "province": "string", "postalCode": "string", "country": "string", "legalEntityIdentifier": "string", "businessName": "string", "accountNumber": "string" }, "beneficiaryCompanyTravelRuleData": { "department": "string", "buildingNumber": "string", "street": "string", "city": "string", "province": "string", "postalCode": "string", "country": "string", "legalEntityIdentifier": "string", "businessName": "string", "accountNumber": "string" }, "beneficiaryPersonTravelRuleData": { "name": "string", "houseNumber": "string", "street": "string", "city": "string", "province": "string", "postalCode": "string", "country": "string", "idNumber": "string", "externalCustomerID": "string", "birthdate": "string", "birthPlace": "string", "accountNumber": "string" }, "currency": "string", "amount": "string", "amountMainUnit": "string", "transactionHash": "string", "originatorParticipant": "string", "beneficiaryParticipant": "string", "initiationDate": "2024-01-15T09:30:00Z", "confirmationDate": "2024-01-15T09:30:00Z", "blockchain": "string", "network": "string" }, "status": "string", "platformFees": [ { "type": "string", "amount": "string", "amountMainUnit": "string", "symbol": "string" } ], "attributes": [ { "id": "string", "key": "string", "value": "string" } ], "forkNumber": "string", "fees": [ { "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" } }, "fees": [ { "type": "string", "amount": "string", "amountMainUnit": "string" } ] } ], "isConfirmed": true } ], "totalItems": "string" } ``` **SDK Code** ```python import requests url = "https://your-protect-instance.example.com/api/rest/v1/transactions" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://your-protect-instance.example.com/api/rest/v1/transactions'; 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/transactions" 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/transactions") 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/transactions") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://your-protect-instance.example.com/api/rest/v1/transactions', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://your-protect-instance.example.com/api/rest/v1/transactions"); 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/transactions")! 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() ```