Getting a list of addresses

The method allows you to get all the user's personal addresses. Deposits and withdrawals are available for all addresses, but the user should only see addresses with isActive: true. Thus, if necessary, you can generate a new address for a user in a certain coin and network, then all previous addresses in this coin and network will have the parameter isActive: false (read more in the previous method "Get/Renew personal address")

Getting a list of addresses

post

/api-gateway/personal-addresses/get-user-addresses

Header parameters

x-api-public-keystring

Public API-key

x-api-signaturestring

Signing the request body with a private API-key

Content-typestring

Request content type

Example: application/json

Body

idstring

Filter by User ID

Example: aa3f81ac-d3eb-482f-8db0-1c7171e75730

isActiveboolean

Filter by parameter 'isActive'

offsetintegerrequired

Offset (for pagination)

limitintegerrequired

Limit (for pagination)

currencystring[]

Currency name

networkstring[]

Network name

sortarray

Sort by. Fields for sorting: 'createdAt'. Order: 'ASC', 'DESC'. Example: [["createdAt", "ASC"]]

Example: [{"0":"createdAt","1":"ASC"}]

balanceobject

Filter by address balance

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.apollopayment.io/api-gateway/personal-addresses/get-user-addresses' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "aa3f81ac-d3eb-482f-8db0-1c7171e75730",
    "isActive": true,
    "offset": 1,
    "limit": 1,
    "currency": [
      "USDT"
    ],
    "network": [
      "ethereum"
    ],
    "sort": [
      {
        "0": "createdAt",
        "1": "ASC"
      }
    ],
    "balance": {
      "from": "23.13",
      "to": "123.55"
    }
  }'

200

200

{
  "success": true,
  "response": [
    {
      "id": "217150d6-a66b-46b6-920d-b839a935504f",
      "userId": "679536e9-ac28-4997-b045-1188b289ebc8",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "balance": "1234.1234",
      "isActive": true,
      "tag": null
    }
  ]
}