Команда Quickex
17 листопада 2025 р.
~1 хв. читання
Розділ instruments надає методи для отримання списку активних інструментів, отримання інформації про окремий інструмент, а також перевірки коректності адреси для вказаного інструмента.
GET
instruments/public
Endpoint URL
https://quickex.io/api/v2/instruments/public
Documentation
Загальний опис
Запит повертає публічний список активних інструментів (монет), доступних для використання в системі Quickex для обраного провайдера ліквідності.
HTTP-запит
Метод: GET
URL: https://quickex.io/api/v2/instruments/public
Приклад запиту
curl -X 'GET' \ 'https://quickex.io/api/v2/instruments/public?providers=hat' \ -H 'accept: application/json'
Параметри запиту
Query-параметри
| Параметр | Тип | Обов’язковий | Опис |
|---|---|---|---|
providers |
array<string> | yes | Список провайдерів ліквідності, з яких потрібно повернути інструменти. Кожен елемент — це рядковий ідентифікатор провайдера (hat, rabbit тощо). |
Формат відповіді
Метод повертає JSON-масив, де кожен елемент — це об’єкт інструменту.
Приклад відповіді
[
{
"currencyTitle": "STX",
"networkTitle": "STX",
"slug": "stxstx",
"currencyFriendlyTitle": "STX",
"precisionDecimals": 8,
"currencyLogoLink": "https://quickex.io/assets/coins/stx.svg",
"requiresMemo": true,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": ""
},
{
"currencyTitle": "AVAX",
"networkTitle": "AVAX",
"slug": "avax",
"currencyFriendlyTitle": "AVAX",
"precisionDecimals": 3,
"currencyLogoLink": "https://quickex.io/assets/coins/avax.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "AVAX",
"contractAddress": ""
},
{
"currencyTitle": "SAND",
"networkTitle": "ERC20",
"slug": "sanderc20",
"currencyFriendlyTitle": "SAND",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/sand.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
}
]
Опис полів відповіді
Приклад об’єкта інструменту
{
"currencyTitle": "SAND",
"networkTitle": "ERC20",
"slug": "sanderc20",
"currencyFriendlyTitle": "SAND",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/sand.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
}
| Поле | Тип | Опис |
|---|---|---|
currencyTitle |
string | Внутрішній код валюти в системі Quickex. |
networkTitle |
string | Код мережі, у якій доступний інструмент (ERC20, TRC20, BTC тощо). |
slug |
string | Унікальний технічний ідентифікатор інструменту в системі Quickex. |
currencyFriendlyTitle |
string | Зручна для читання назва валюти. |
precisionDecimals |
number | Кількість знаків після коми, які підтримуються для операцій з інструментом. |
currencyLogoLink |
string | URL логотипа валюти. |
requiresMemo |
boolean | Чи потрібні Memo/Tag/Payment ID для надсилання коштів. |
instrumentType |
string | Тип інструменту (crypto, fiat тощо). |
bestChangeName |
string | Назва інструменту в агрегаторі BestChange. |
contractAddress |
string | Адреса смартконтракту токена (для мереж на кшталт Ethereum/BSC). Для нативних монет — порожнє значення. |
Можливі сценарії використання
- Формування списку валют у формі обміну.
- Попереднє завантаження довідника інструментів для кешування.
- Перевірка, чи підтримує провайдер потрібну мережу або монету.
- Відображення логотипів, назв і правил округлення в інтерфейсі.
- Валідація введених сум (з урахуванням
precisionDecimals).
Code Sample
curl -X 'GET' \
'https://quickex.io/api/v2/instruments/public' \
-H 'accept: application/json'Response Example
[
{
"currencyTitle": "STX",
"networkTitle": "STX",
"slug": "stxstx",
"currencyFriendlyTitle": "STX",
"precisionDecimals": 8,
"currencyLogoLink": "https://quickex.io/assets/coins/stx.svg",
"requiresMemo": true,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": ""
},
{
"currencyTitle": "AVAX",
"networkTitle": "AVAX",
"slug": "avax",
"currencyFriendlyTitle": "AVAX",
"precisionDecimals": 3,
"currencyLogoLink": "https://quickex.io/assets/coins/avax.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "AVAX",
"contractAddress": ""
},
{
"currencyTitle": "SAND",
"networkTitle": "ERC20",
"slug": "sanderc20",
"currencyFriendlyTitle": "SAND",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/sand.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"bestChangeName": "",
"contractAddress": "0x3845badade8e6dff049820680d1f14bd3903a5d0"
}
]Try it out
Leave empty to use default
Headers
GET
instrument
Endpoint URL
https://quickex.io/api/v2/instrument
Documentation
Загальний опис (окремий інструмент)
Запит повертає публічну інформацію про один інструмент (конкретну монету в конкретній мережі), доступний у системі Quickex.
Метод корисний, коли потрібно отримати детальну інформацію про один інструмент, знаючи його currencyTitle та networkTitle:
HTTP-запит
Метод: GET
URL: https://quickex.io/api/v2/instrument
Приклад запиту
curl -X 'GET' \ 'https://quickex.io/api/v2/instrument?currencyTitle=ADA&networkTitle=ADA' \ -H 'accept: application/json'
Параметри запиту
Query-параметри
| Параметр | Тип | Обов’язковий | Опис |
|---|---|---|---|
currencyTitle |
string | yes | Код валюти (наприклад, ADA, BTC, USDT). |
networkTitle |
string | yes | Назва мережі, у якій існує інструмент (ADA, ERC20 тощо). |
Обидва параметри мають одночасно відповідати наявному інструменту в системі.
Формат відповіді
Метод повертає JSON-об’єкт, що описує інструмент.
Приклад відповіді
{
"currencyTitle": "ADA",
"networkTitle": "ADA",
"currencyFriendlyTitle": "Cardano",
"precisionDecimals": 11,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
"instrumentType": "crypto",
"bestChangeName": "USDTTRC20",
"contractAddress": "string"
}
Опис полів відповіді
{
"currencyTitle": "ADA",
"networkTitle": "ADA",
"currencyFriendlyTitle": "Cardano",
"precisionDecimals": 11,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png",
"instrumentType": "crypto",
"bestChangeName": "USDTTRC20",
"contractAddress": "string"
}
| Поле | Тип | Опис |
|---|---|---|
currencyTitle |
string | Внутрішній код валюти в системі Quickex (наприклад, ADA, BTC, USDT). |
networkTitle |
string | Код мережі, у якій доступний інструмент (ADA, ERC20, TRC20 тощо). |
currencyFriendlyTitle |
string | Зручна для читання назва валюти (наприклад, Cardano замість ADA). |
precisionDecimals |
number | Кількість підтримуваних знаків після коми для сум. |
requiresMemo |
boolean | Чи потрібні Memo/Tag/Payment ID для переказів. |
currencyLogoLink |
string | URL логотипа валюти. |
instrumentType |
string | Тип інструменту, наприклад crypto. |
bestChangeName |
string | Назва інструменту в BestChange. |
contractAddress |
string | Адреса контракту токена або порожній рядок для нативних монет. |
Можливі сценарії використання
- Отримання детальної інформації про конкретну монету для відображення у фронтенді.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/instruments/public/one' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20"
}'Response Example
{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"currencyFriendlyTitle": "USDT",
"precisionDecimals": 2,
"currencyLogoLink": "https://quickex.io/assets/coins/usdt.svg",
"requiresMemo": false,
"instrumentType": "crypto",
"contractAddress": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t"
}Try it out
Leave empty to use default
Headers
POST
instruments/public/validate-address
Endpoint URL
https://quickex.io/api/v2/instruments/public/validate-address
Documentation
Загальний опис
Перевіряє коректність адреси для вказаної валюти та мережі. Повертає true, якщо адреса відповідає вимогам формату та мережі; інакше повертає false або помилку.
Параметри
Заголовки
| Назва | Обов’язково | Опис |
|---|---|---|
X-Api-Public-Key |
так | Ваш публічний API-ключ. |
X-Api-Timestamp |
так | Мітка часу у форматі UNIX (мс). |
X-Api-Signature |
так | HMAC-підпис тіла запиту, створений за допомогою вашого секретного ключа. |
Тіло запиту (JSON)
| Поле | Тип | Обов’язково | Опис |
|---|---|---|---|
currencyTitle |
string | так | Код валюти (наприклад, USDT). |
networkTitle |
string | так | Мережа валюти (наприклад, TRC20). |
address |
string | так | Адреса для перевірки. |
Приклад запиту
curl -X POST 'https://quickex.io/api/v2/instruments/public/validate-address' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Public-Key: yourPublicKey' \
-H 'X-Api-Timestamp: 1691400050000' \
-H 'X-Api-Signature: yourHmacSignature' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"address": "THUmkPhry61edcTf79yTioV6292ccsuCjV"
}'
Приклади відповідей
200 OK — адреса коректна:
true400 ERR_INVALID_ADDRESS — адреса не відповідає формату мережі:
false500 ERR_UNKNOWN — інструмент не знайдено або сталася внутрішня помилка:
{
"status": "ERR_UNKNOWN",
"message": "code=404, message=Not Found",
"data": null
}
Випадок використання
Перед створенням ордера фронтенд перевіряє адресу, введену користувачем: якщо метод повертає true, форма продовжує роботу; якщо ні — виводиться помилка з проханням перевірити адресу.
Code Sample
curl -X 'POST' \
'https://quickex.io/api/v2/instruments/validate-address' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"address": "THUmkPhry61edcTf79yTioV6292ccsuCjV",
"memo": "2345678",
"getRejectReason": true
}'Response Example
{
"status": "ERR_HTTP",
"message": "Http Exception",
"data": {
"address": "adddress is incorrect"
}
}Try it out
Leave empty to use default