Получить всех контрагентов

Позволяет получить список клиентов (контрагентов) с фильтрацией, сортировкой и пагинацией. Используется для поиска конкретного клиента или анализа всей базы клиентов.

💡 Важно: Можно передавать сложные фильтры с логикой and / or, чтобы комбинировать разные условия.

GET/v1/clients

Headers

Example of x-api-key

74364121-2fb8-4e06-b093-7b1f83f0d5a8

Please note: the x-api-key is unique and provided to each client individually by Monocrypt.

---

Query Parameters 📝

Фильтры передаются в JSON формате на бэкенд, но под капотом это превращается в строку query-параметров.

Пример JSON фильтра:

{
  "and": [
    { "or": [{ "txId": { "iLike": "%5fe07d8de..." } }] },
    { "or": [{ "currency": { "eq": "USDT" } }, { "currency": { "eq": "USDC" } }] },
    { "or": [{ "network": { "eq": "TRC20" } }, { "network": { "eq": "ERC20" } }] },
    { "or": [{ "status": { "eq": "completed" } }] }
  ]
}

---

Как это выглядит в браузере / URL 🌐

При отправке GET-запроса JSON конвертируется в URL-encoded строку:

paging[limit]=100&
paging[offset]=0&
sorting[0][field]=createdAt&
sorting[0][direction]=DESC&
filter[and][0][or][0][txId][iLike]=%255fe07d8de...
&filter[and][1][or][0][currency][eq]=USDT
&filter[and][1][or][1][currency][eq]=USDC
&filter[and][2][or][0][network][eq]=TRC20
&filter[and][2][or][1][network][eq]=ERC20
&filter[and][3][or][0][status][eq]=completed

💡 Важно:

• Все вложенные объекты and / or превращаются в ключи с квадратными скобками.

• %25 — это кодировка символа %, которая используется для iLike фильтров.

• Таким образом, в браузере или через Axios / Postman фильтр отправляется как строка, а не как JSON.

Пример запроса через Axios ⚡

const response = await axios.get('/v1/clients', {
  headers: { 'x-api-key': 'YOUR_API_KEY' },
  params: {
    paging: { limit: 100, offset: 0 },
    sorting: [{ field: 'createdAt', direction: 'DESC' }],
    filter: {
      and: [
        { or: [{ txId: { iLike: "%5fe07d8de..." } }] },
        { or: [{ currency: { eq: "USDT" } }, { currency: { eq: "USDC" } }] },
        { or: [{ network: { eq: "TRC20" } }, { network: { eq: "ERC20" } }] },
        { or: [{ status: { eq: "completed" } }] }
      ]
    }
  }
});

---

Особенности ⚡

• Запрос поддерживает фильтрацию, пагинацию и сортировку.

• Для передачи сложных условий используйте and / or комбинации.

• Поля фильтров должны соответствовать сущности клиента и его кошельков.

• Для полной документации по фильтрам, операторах и примерах смотрите 👉 Фильтрация

---

Response

200 OK

{
    "nodes": [
        {
            "id": 35,
            "createdAt": "2024-12-06T14:11:02.675Z",
            "updatedAt": "2024-12-09T09:16:03.190Z",
            "clientId": 35,
            "uuid": "f44c3c11-f5ff-4d18-b735-d81afa1d5df3",
            "email": "testgmail.com",
            "name": "PLbedbedeebecffa",
            "rootUnitId": 6,
            "unitId": 4,
            "isExternalParam": false,
            "unit": {
                "id": 4,
                "createdAt": "2024-11-25T16:36:40.311Z",
                "updatedAt": "2025-06-27T06:42:56.855Z",
                "uuid": "e0294f3d-f976-413f-aa34-e82611f57779",
                "name": "DEV",
                "rootUnitId": 6,
                "parentId": null,
                "adminIds": [],
                "description": null,
                "isActive": true,
                "logo": null
            },
            "wallets": [
                {
                    "id": 189,
                    "createdAt": "2024-12-06T14:11:02.994Z",
                    "updatedAt": "2025-07-08T12:54:20.094Z",
                    "subId": null,
                    "clientId": 35,
                    "unitId": null,
                    "invoiceId": null,
                    "name": "PL-b9e0db4e-908d-4e3e-8b37-13317ec5ffa8",
                    "currency": "TRX",
                    "network": "TRC20",
                    "balance": 0,
                    "transit_balance": 0,
                    "service_fee_balance": 0,
                    "walletAddress": "TTJW3idzSZ47DEdkamNXnPd1EDbfZvsSNh",
                    "riskScore": 0,
                    "total_deposits": "12000000"
                },
            ],
            "labels": []
        }
    ],
    "totalCount": 1
}