Fetching whitelisted addresses

Fetch whitelisted addresses

Fetch whitelisted addresses.

GET/api/v1/whitelist-addresses

Authorization

ApiKeyAuth

Query parameters

Response

200

Returns the matching whitelisted addresses.

Body

application/json

id*string (uuid)

Address ID.

clientAddressId*string

Address ID provided by the client.

currency*enum

Address' intended currency.

BCHBTCETHLINKLTCSOLUSDCXLMXRP

network*enum

Blockchain.

BCHBTCLTCXLMXRPETHBSCSOLTRX

address*string

Crypto address.

destinationTagstring

XLM/XRP destination tag.

labelstring

Label of the address, useful for grouping multiple whitelisted addresses.

createdAt*integer (int64)

UNIX seconds at which the address was created.

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/whitelist-addresses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "clientAddressId": "text",
  "currency": "BCH",
  "network": "BCH",
  "address": "text",
  "destinationTag": "text",
  "label": "text",
  "createdAt": 0
}