Getting A List Of Addresses
Basic Description
This endpoint is used to retrieve a list of Addresses in Taurus-PROTECT.
To understand what is an Address please refer to the following page in the Taurus User Guides.
This endpoint would accept a GET request with no required parameters. By default, the request will return all addresses with a default limit of 100. However, it also provides the flexibility to filter addresses based on various parameters, including currency, positive balance, ScoreChain score, wallet ID, customer ID, and more. Furthermore, the resulting list can be sorted according to specific criteria.
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 addresses currently created within Taurus-PROTECT, the request will return an empty list. Similarly, if the filters added do not match any addresses, the request will return 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/addresses" \
--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/addresses with no parameters.
Call Result
A successful response for the GET call to get the list of addresses might look like this:
{
"result": [
{
"id": "727281",
"walletId": "71488",
"currency": "DOT",
"addressPath": "m/44'/354'/20'/0'/1'",
"addressIndex": "1",
"address": "156ogVPxAp6vAxxXNgbAh7T3qXP6yMJ5p1R4TW8fU2cupdTL",
"label": "City Road address ADR1",
"balance": {
"totalConfirmed": "0",
"totalUnconfirmed": "0",
"availableConfirmed": "0",
"availableUnconfirmed": "0",
"reservedConfirmed": "15000000000",
"reservedUnconfirmed": "15000000000"
},
"signature": "+56HK2kx6Ivt0nYE6OTG3Cg7gSe6XJ4KpWkzZitSj8thZOwwAorjKZusMJZBlr9INkDhi2kqizT/KDouSxz0UA==",
"creationDate": "2023-04-13T09:01:19.862908Z",
"updateDate": "2023-04-13T09:01:36.562160Z",
"walletInfo": {
"id": "71488",
"balance": {
"totalConfirmed": "10000000000",
"totalUnconfirmed": "10000000000",
"availableConfirmed": "0",
"availableUnconfirmed": "0",
"reservedConfirmed": "30000000000",
"reservedUnconfirmed": "30000000000"
},
"currency": "DOT",
"coin": "DOT",
"name": "Polkadot",
"accountPath": "m/44'/354'/20'",
"creationDate": "2023-04-13T08:25:53.137988Z",
"updateDate": "2023-04-13T08:25:53.137988Z",
"blockchain": "DOT",
"currencyInfo": {
"name": "Polkadot",
"symbol": "DOT",
"coinTypeIndex": "354",
"blockchain": "DOT",
"decimals": "10",
"hasStaking": true,
"isAccountBased": true,
"enabled": true,
"id": "cadc2268107de6d9749ca1d1a2f8df20f7cea5263a5cf3fb852395be08947a13",
"displayName": "Polkadot - DOT",
"type": "native",
"network": "mainnet"
},
"network": "mainnet"
},
"currencyInfo": {
"name": "Polkadot",
"symbol": "DOT",
"coinTypeIndex": "354",
"blockchain": "DOT",
"decimals": "10",
"hasStaking": true,
"isAccountBased": true,
"enabled": true,
"id": "cadc2268107de6d9749ca1d1a2f8df20f7cea5263a5cf3fb852395be08947a13",
"displayName": "Polkadot - DOT",
"type": "native",
"network": "mainnet"
},
"canUseAllFunds": true
},
{
"id": "727279",
"walletId": "71488",
"currency": "DOT",
"addressPath": "m/44'/354'/20'/0'/0'",
"address": "12Egh6o5oP7T31QPDczvY67aoeRyjsavaBKphb44nh2ZhhGN",
"label": "City Road address ADR1",
"balance": {
"totalConfirmed": "10000000000",
"totalUnconfirmed": "10000000000",
"availableConfirmed": "0",
"availableUnconfirmed": "0",
"reservedConfirmed": "15000000000",
"reservedUnconfirmed": "15000000000"
},
"signature": "61lRIfzNGf4ym/r7+UDKVEOFlmtI8c9ORjUiJSAJ1uQ7GoaUEY5DpETk9D3J9ZCMACrXrMIjDuCxfK15x4T6Sg==",
"scores": [
{
"id": "5657",
"provider": "chainalysis",
"type": "risk",
"score": "0",
"updateDate": "2023-05-21T13:11:51.594901Z"
}
],
"creationDate": "2023-04-13T08:30:50.934783Z",
"updateDate": "2023-04-13T08:31:36.182132Z",
"walletInfo": {
"id": "71488",
"balance": {
"totalConfirmed": "10000000000",
"totalUnconfirmed": "10000000000",
"availableConfirmed": "0",
"availableUnconfirmed": "0",
"reservedConfirmed": "30000000000",
"reservedUnconfirmed": "30000000000"
},
"currency": "DOT",
"coin": "DOT",
"name": "Polkadot",
"accountPath": "m/44'/354'/20'",
"creationDate": "2023-04-13T08:25:53.137988Z",
"updateDate": "2023-04-13T08:25:53.137988Z",
"blockchain": "DOT",
"currencyInfo": {
"name": "Polkadot",
"symbol": "DOT",
"coinTypeIndex": "354",
"blockchain": "DOT",
"decimals": "10",
"hasStaking": true,
"isAccountBased": true,
"enabled": true,
"id": "cadc2268107de6d9749ca1d1a2f8df20f7cea5263a5cf3fb852395be08947a13",
"displayName": "Polkadot - DOT",
"type": "native",
"network": "mainnet"
},
"network": "mainnet"
},
"disabled": true,
"currencyInfo": {
"name": "Polkadot",
"symbol": "DOT",
"coinTypeIndex": "354",
"blockchain": "DOT",
"decimals": "10",
"hasStaking": true,
"isAccountBased": true,
"enabled": true,
"id": "cadc2268107de6d9749ca1d1a2f8df20f7cea5263a5cf3fb852395be08947a13",
"displayName": "Polkadot - DOT",
"type": "native",
"network": "mainnet"
},
"canUseAllFunds": true
}
],
"totalItems": "2"
}
In this example, Taurus-PROTECT responds with a JSON object containing a list of all the relevant addresses.
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 22 days ago