Author profile photo
Команда Quickex
13 сентября 2024 г.
~10 мин. чтения

instrumentsGET

Получить публичный список всех активных инструментов

Параметры

Нет параметров

Ответ

Возвращает список всех активных инструментов

[
{
"currencyTitle": "ADA",
"networkTitle": "ADA",
"currencyFriendlyTitle": "Cardano",
"precisionDecimals": 11,
"requiresMemo": false,
"currencyLogoLink": "https://static.coinall.ltd/cdn/assets/imgs/221/5FFE6AFD21B40243.png"
}
]

rates-infoGET

Получить выбранную пару публичной информации

Параметры

instrumentFromCurrencyTitle

string
*required
 Название валюты отправляющего инструмента

Пример:BTC
instrumentFromNetworkTitle

string
*required
 Название отправляющей инструментальной сети

Пример:BTC
instrumentToCurrencyTitle

string
*required
 Наименование валюты принимающего инструмента

Пример:USDT
instrumentToNetworkTitle

string
*required
 Название сети приемного прибора

Пример:TRC20
claimedDepositAmount

string
 Сумма для отправки пользователем

Пример:1

Ответ

Возвращает парный информационный объект

{
"instrumentFrom": {
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"precisionDecimals": 12
},
"instrumentTo": {
"currencyTitle": "BTC",
"networkTitle": "BTC",
"precisionDecimals": 11
},
"depositRules": {
"minAmount": "72.81550376835",
"maxAmount": "0"
},
"withdrawalRules": {
"minAmount": "0.00141001",
"maxAmount": "0",
"withdrawalFeeRules": {
"maxAmount": "0.0004",
"minAmount": "0.0004"
}
},
"minConfirmationsToWithdraw": 20,
"minConfirmationsToTrade": 20,
"price": "0.00001936165401188960303",
"reversePrice": "51648.480000000003909",
"updatedAt": "2024-02-20T03:44:50.000Z",
"liquidityProviderPublicCode": "radio",
"amountToGet": "0.06389345823923569",
"marketMinAmount": "3300"
}

Коды ошибок

422 Возвращает, если пара не поддерживается
406 Возврат, если сумма для отправки слишком мала

validate-addressPOST

Проверяет адрес для данного инструмента

Параметры

currencyTitle

string
*required
 Название валюты инструмента

Пример:BTC
networkTitle

string
*required
 Название сети инструментов

Пример:BTC
address

string
*required
 Адрес для проверки

Пример:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Ответ

Возвращает логическое значение

true

createPOST

Создает заказ на обмен

Параметры

instrumentFrom

object
*required
 Отправка информации об инструменте

Пример:{ "currencyTitle": "USDT", "networkTitle": "TRC20" }
instrumentTo

object
*required
 Получение информации об инструменте

Пример:{ "currencyTitle": "BTC", "networkTitle": "BTC" }
destinationAddress

string
*required
 Адрес назначения

Пример:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
destinationAddressMemo

string or null
*required
 Destination memo (если существует)

Пример:null
refundAddress

null
 В данный момент не поддерживается

Пример:null
refundAddressMemo

null
 В данный момент не поддерживается

Пример:null
claimedDepositAmount

number
*required
 Заявленная сумма к отправке в момент создания заказа

Пример:43350
userEmail

string or null
 Адрес электронной почты пользователя для уведомлений

Пример:null
referrerId

string or null
 Партнерский идентификатор для справки

Пример:aff_41

Ответ

Возвращает объект заказа

{
"createdAt": "2024-02-20T03:46:45.736Z",
"orderId": 618,
"userEmail": null,
"refundAddress": null,
"destinationAddress": "bc1qfcgrdw99lr7v2sp6at6vna7dxhwvcrgj0s887w",
"claimedNetworkFee": "0.0004",
"claimedPublicRate": {
"price": "0.00001936597539494728",
"updatedAt": "2024-02-20T03:46:45.062Z",
"reversePrice": "51636.955"
},
"claimedDepositAmount": "3300",
"amountToGet": "0.063907718803",
"rateMode": "FLOATING",
"userId": null,
"referrerAffiliateId": "aff_41",
"pair": {
"instrumentFrom": {
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"precisionDecimals": 12
},
"instrumentTo": {
"currencyTitle": "BTC",
"networkTitle": "BTC",
"precisionDecimals": 11
}
},
"orderEvents": [
{
"createdAt": "2024-02-20T03:46:45.736Z",
"kind": "CREATION_END"
}
],
"depositAddress": {
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"depositAddress": "TJvW1jY5xUCEobvAUJrZvoMeS8R3qQ5ThX",
"depositAddressMemo": null
},
"deposits": [],
"withdrawals": [],
"KYCFormLink": null,
"liquidityProviderPublicCode": "radio"
}

order-infoGET

Возвращает публичную информацию о статусе заказа

Параметры

orderId

number
*required
 Идентификатор заказа

Пример:31954
destinationAddress

string
*required
 Адрес назначения пользователя

Пример:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Ответ

Возвращает объект статуса заказа

{
"deposits": [
{
"createdAt": "2024-01-30T13:32:26.141Z",
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"amount": "1000.1",
"confirmations": 0,
"txId": "0xdeadc0dedeadbeef",
"depositAddress": "0xdeadc0de"
}
],
"withdrawals": [
{
"createdAt": "2024-01-30T13:32:26.141Z",
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"amount": "1000.1",
"networkFee": "1.1",
"txId": "0xdeadc0dedeadbeef"
}
],
"depositAddress": {
"orderId": 0,
"liquidityProviderTitle": "WHITEBIT_BUSINESS_ACCOUNT",
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"depositAddress": "0xdeadc0de"
},
"orderId": 0,
"createdAt": "2024-01-30T13:32:26.141Z",
"claimedDepositAmount": "10.01",
"claimedPublicRate": {
"price": "1000.1",
"reversePrice": "1000.1",
"updatedAt": "2024-01-30T13:32:26.141Z",
"liquidityProviderPublicCode": "formulae",
"claimedAmountToReceive": "0.01"
},
"claimedNetworkFee": "10.01",
"KYCFormLink": "string",
"orderEvents": {
"kind": "TRACKING_STARTED",
"createdAt": "2024-01-30T13:32:26.141Z"
},
"userEmail": "test@example.com",
"destinationAddress": "0xdeadbeef"
}

Примечания

Шаги по обработке обменов

Field Описание
deposits Когда этот массив пуст, это означает, что депозит еще не получен. Мы остаемся на начальном этапе, ожидая депозит пользователя. Как только массив содержит записи, это означает, что депозит получен, и мы можем перейти к следующему этапу. Обратите внимание, что пользователь может сделать несколько депозитов, и для отображения правильной общей суммы депозита необходимо суммировать значения в поле «amount» каждого элемента массива.
withdrawals[0].txId Массив “withdrawals” остается пустым, пока идет торговля. Получение объекта с “txId” означает, что транзакция завершена, что позволяет нам поздравить пользователя с успешным выполнением его заказа.

set-emailPOST

Устанавливает адрес электронной почты пользователя для уведомления пользователя о заказе

Параметры

orderId

number
*required
  ID заявки

Пример:31954
userEmail

string
*required
  email пользователя

Пример:test_294614693@test.com

Ответ

Возвращает объект статуса заказа

{
"createdAt": "2024-01-29T22:24:37.903Z",
"orderId": 556,
"userEmail": "user@email.com",
"legacyOrderId": null,
"refundAddress": null,
"destinationAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
"claimedNetworkFee": "0.0004",
"claimedPublicRate": {
"price": "0.00002319399117909321",
"updatedAt": "2024-01-29T22:24:28.573Z",
"reversePrice": "43114.615000000005"
},
"claimedDepositAmount": "3300",
"pair": {
"instrumentFrom": {
"currencyTitle": "USDT",
"networkTitle": "TRC20",
"precisionDecimals": 12
},
"instrumentTo": {
"currencyTitle": "BTC",
"networkTitle": "BTC",
"precisionDecimals": 11
}
},
"orderEvents": [
{
"createdAt": "2024-01-29T22:24:37.903Z",
"kind": "CREATION_END"
}
],
"depositAddress": {
"instrument": {
"currencyTitle": "USDT",
"networkTitle": "TRC20"
},
"depositAddress": "TH1V2xkH9VpoiRSGfubnqtz3GiRpjieswN",
"depositAddressMemo": null
},
"deposits": [],
"withdrawals": [],
"KYCFormLink": null,
"liquidityProviderPublicCode": "radio"
}

Коды ошибок

400 Возвращает, если адрес электронной почты недействителен
403 Возвращает, если адрес электронной почты уже установлен (он не может быть установлен дважды)
404 Возврат, если заказ не найден
422 Возврат, если заказ уже обработан
Поделиться статьей: