Fetch whitelisted addresses

Request

Authorization

Add parameter in header

FRX-API

Example:

FRX-API: ********************

Query Params

id

string <uuid>

optional

Whitelisted address ID.

clientAddressId

string

optional

Address ID provided by the client.

currency

enum<string>

optional

Address cryptocurrency.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

Example:

BTC

label

string

optional

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

Example:

Users in Europe

before

integer <int64>

optional

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

Example:

1702894529

after

integer <int64>

optional

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

Example:

1702894529

descending

string

optional

Sort the results (by createdAt) in descending order.

Default:

true

Example:

true

limit

integer

optional

Limit of the results per request.

<= 2000

Default:

25

Example:

25

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Returns the matching whitelisted addresses.

application/json

Body

id

string <uuid>

required

Address ID.

clientAddressId

string

required

Address ID provided by the client.

currency

enum<string>

required

Address' intended currency.

Allowed values:

BCHBNBBTCETHLINKLTCSOLTRXUSDCUSDTXLMXRP

network

enum<string>

required

Blockchain.

Allowed values:

BCHBTCLTCXLMXRPETHBSCSOLTRX

address

string

required

Crypto address.

destinationTag

string

optional

XLM/XRP destination tag.

label

string

optional

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

createdAt

integer <int64>

required

UNIX seconds at which the address was created.

Examples

SuccessSuccess

{
    "address": "r9vLJhJG2mfdEuU4joACKLx6ovMLeuiaSC",
    "clientAddressId": "Address 1",
    "createdAt": 1677674793,
    "currency": "XRP",
    "destinationTag": "123344",
    "id": "3fcf9817-9e0e-42e7-bf90-f9ffd7548630",
    "label": "Label",
    "network": "XRP"
}