Getting details of all your whitelists

🔗
https://openapi.rakkardigital.com/v1/whitelist

To get a list of your whitelists, use the endpoint GET /whitelist to retrieve information and details on all your whitelists. To do this the user must have viewer as their API key role.

Query Parameters

Users can filter their request by using the following parameters :

Component	Type	Description
limit	number	Default at 200
offset	number	Offset for pagination
whitelist_type	string	Type of whitelist to filter by
asset_id	string	Asset ID to retrieve in whitelist
network_id	string	Network ID to retrieve in whitelist

Enumerated values are the predefined values that the variable can take. For example, "whitelist_type" value can either be "my_organization" or "third_party"

Parameter	Possible Values
whitelist_type	my_organization, third_party

Response

The list of whitelist will contain and array of whitelists as a JSON object with the following details :

Component	Type	Description
whitelists	string	Whitelists
whitelist_id	string	ID of the whitelist
whitelist_name	string	Name of the whitelist
whitelist_type	string	Type of the whitelist

The detail of the "assets" will include the following components:

Component	Type	Description
asset_id	string	ID of the asset
asset_name	string	Name of the asset
network_id	string	ID of the network
network_name	string	Name of the network
address	string	Wallet address
memo	string	Memo for address of asset types with memo, tag or note

Example Response

{
        "timestamp": "2019-03-04T12:58:12.000Z",
        "whitelists": [
            {
                "whitelist_id": "788",
                "whitelist_name": "Nanthapass",
                "whitelist_type": "Third party",
                "assets":[ 
                    {
                        "asset_id": "ETH",
                        "asset_name": "Ethereum",
                        "network_id" : "ETH",
                        "network_name": "Ethereum",
                        "address": "0wnf9ac",
                        "memo": ""
                    },
                    {
                        "asset_id": "BTC",
                        "asset_name": "Bitcoin",
                        "network_id": "BTC",
                        "network_name": "Bitcoin",
                        "address": "3FZbgi29cpjq2Gj..",
                        "memo": ""
                    }
                ]
            },
            {
                "whitelist_id": "1367",
                "whitelist_name": "Greener",
                "whitelist_type": "My organization's",
                "assets":
                    {
                        "asset_id": "XRP",
                        "asset_name": "Ripple",
                        "network_id": "XRP",
                        "network_name": "Ripple",
                        "address": "rBjXGvdHt1...",
                        "memo": "4058079792"
                }
            }
        ], 
		}