APIv1

Author profile photo
Команда Swapgate
12 сентября 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
*обязательно
 Название валюты инструмента отправки

Пример:BTC
instrumentFromNetworkTitle

string
*обязательно
 Название сети инструмента отправки

Пример:BTC
instrumentToCurrencyTitle

string
*обязательно
 Название валюты инструмента получения

Пример:USDT
instrumentToNetworkTitle

string
*обязательно
 Название сети инструмента получения

Пример: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
*обязательно
 Название валюты инструмента

Пример:BTC
networkTitle

string
*обязательно
 Название сети инструмента

Пример:BTC
address

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

Пример:bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Ответ

Возвращает булево значение

true

createPOST

Создаёт ордер обмена

Параметры

referrerId

string or null

Партнёрский (реферальный) ID

Пример: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
*обязательно
 ID ордера

Пример:31954
destinationAddress

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

Пример: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

Устанавливает email пользователя для уведомления об ордере

Параметры

orderId

number
*обязательно
 ID ордера

Пример:31954
userEmail

string
*обязательно
 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 Возвращается, если email некорректен
403 Возвращается, если email уже задан (нельзя задать повторно)
404 Возвращается, если ордер не найден
422 Возвращается, если ордер уже обработан

Ответ

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

{
"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

Устанавливает email пользователя для уведомления об ордере

 

Параметры

orderId

number
*обязательно
 ID ордера

Пример:31954
userEmail

string
*обязательно
 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 Возвращается, если email некорректен
403 Возвращается, если email уже задан (нельзя задать повторно)
404 Возвращается, если ордер не найден
422 Возвращается, если ордер уже обработан
Поделиться статьей: