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

Header parameters

x-api-public-keystringOptional

Public API-key

x-api-signaturestringOptional

Signing the request body with a private API-key

Content-typestringOptional

Request content type

Example: application/json

Body

Address list request body

idstringOptional

Filter by User ID

Example: c886f2dd-669a-4657-ba10-9ad7700cc8e5

isActivebooleanOptional

Filter by parameter 'isActive'

currencystring[]Optional

Filter by currencies

Example: USDT

networkstring[]Optional

Filter by networks

Example: ethereum

balanceobjectOptional

Filter by address balance

sortarrayOptional

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

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

offsetintegerRequired

Offset (for pagination)

limitintegerRequired

Limit (for pagination)

Responses

application/json

objectOptional

Successful response

post

HTTPcURLJavaScriptPython

POST /api-gateway/personal-addresses/get-user-addresses HTTP/1.1
Host: ocp.onchainpay.io
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "id": "c886f2dd-669a-4657-ba10-9ad7700cc8e5",
  "isActive": true,
  "currency": [
    "USDT"
  ],
  "network": [
    "ethereum"
  ],
  "balance": {
    "from": "23.13",
    "to": "123.55"
  },
  "sort": [
    {
      "0": "createdAt",
      "1": "ASC"
    }
  ],
  "offset": 1,
  "limit": 1
}

200Success

{
  "success": true,
  "response": [
    {
      "id": "2361c9b9-8c89-40b0-ab90-1ade882cf756",
      "userId": "a4aaa006-0fd1-4413-8433-d0fe45c15f89",
      "currency": "USDT",
      "network": "ethereum",
      "address": "0x515b72ed8a97f42c568d6a143232775018f133c8",
      "tag": null,
      "balance": "1234.1234",
      "isActive": true
    }
  ]
}