Getting A List Of Currencies
Basic Description
This endpoint is used to get a list of all the Currencies in Taurus-PROTECT.
This endpoint would accept a GET request with no required parameters. There is only one available optional parameter which is: showDisabled. If showDisabled is set to true, then all currencies, both enabled and disabled, will be returned.
Prerequisites
Required Roles
Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.
Here is the list of required Roles for this particular endpoint:
- TPUser
To find out more about roles, please refer to the following page in the Taurus User Guides.
Required Input Parameters
There are no Required Input Parameters for this endpoint.
Preconditions
It is important to note that if there are no enabled Currencies within Taurus-PROTECT, the request will result in an empty list.
Call Example
You can find a basic example in cURL below.
Please note that you will need to update the BASEURL and the APITOKEN for the command to function.
export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/currencies" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken"
This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/currencies with no parameters.
Call Result
A successful response for the GET call to get the list of currencies might look like this:
{
"result": [
{
"name": "The Graph",
"symbol": "GRT",
"blockchain": "ETH",
"isToken": true,
"isERC20": true,
"decimals": "18",
"contractAddress": "0xc944e90c64b2c07662a292be6244bdf05cda44a7",
"isAccountBased": true,
"enabled": true,
"id": "f770771975d1c8dfc73283a0521ae92b01f9a41364974bd46fcc4cd2093a791d",
"displayName": "ETH - GRT",
"type": "token",
"wlcaId": "396",
"network": "mainnet"
},
{
"name": "XYZ NFT",
"symbol": "XYZ",
"blockchain": "ETH",
"isToken": true,
"decimals": "0",
"contractAddress": "0x725ce1dad7ee185c2c686c821e1ad743201358d7",
"isAccountBased": true,
"isNFT": true,
"enabled": true,
"id": "f7629243abbcf27f87750a25db8213ca7c93508b87c561faa5896d3b22a43aab",
"displayName": "ETH - XYZ",
"type": "token",
"wlcaId": "369",
"network": "mainnet"
},
{
"name": "UDC",
"symbol": "USDC",
"blockchain": "ETH",
"isToken": true,
"isERC20": true,
"decimals": "6",
"contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
"isAccountBased": true,
"enabled": true,
"id": "0268adfbd13664fd28e520e580b4de05be39b603ba0675091974ec27aea1994c",
"displayName": "ETH - USDC",
"type": "token",
"wlcaId": "95",
"network": "mainnet"
}
]
}
In this example, Taurus-PROTECT responds with a JSON object containing a list of all the enabled and disabled currencies in Taurus-PROTECT.
Requirements for Future Use
For this endpoint, the storing requirements vary according to the use case.
You can find the Swagger-generated page for this endpoint in the following link.
Updated 23 days ago