Fetching whitelisted addresses

Fetch whitelisted addresses

get

Fetch whitelisted addresses.

Authorizations

Query parameters

idstring · uuidOptional

Whitelisted address ID.

clientAddressIdstringOptional

Address ID provided by the client.

currencystring · enumOptional

Address cryptocurrency.

Example: BTCPossible values:

labelstringOptional

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

Example: Users in Europe

beforeinteger · int64Optional

Address creation date range start, in UNIX seconds, exclusive.

Example: 1702894529

afterinteger · int64Optional

Address creation date range end, in UNIX seconds, exclusive.

Example: 1702894529

descendingstringOptional

Sort the results (by createdAt) in descending order.

Default: trueExample: true

limitinteger · max: 2000Optional

Limit of the results per request.

Default: 25Example: 25

Responses

200

Returns the matching whitelisted addresses.

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /api/v1/whitelist-addresses HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Returns the matching whitelisted addresses.

[
  {
    "address": "r9vLJhJG2mfdEuU4joACKLx6ovMLeuiaSC",
    "clientAddressId": "Address 1",
    "createdAt": 1677674793,
    "currency": "XRP",
    "destinationTag": "123344",
    "id": "3fcf9817-9e0e-42e7-bf90-f9ffd7548630",
    "label": "Label",
    "network": "XRP"
  },
  {
    "address": "0xcefcca169357a18eb8c3f230f92b58562e48cae5",
    "clientAddressId": "Address 2",
    "createdAt": 1676465834,
    "currency": "ETH",
    "id": "4a188186-4f1c-4797-ba43-98a8274e4067",
    "label": "Label",
    "network": "BSC"
  }
]