Документация Coincraddle API

Начало работы
Все запросы к API Coincraddle должны содержать параметр `key` (API key) доступный после регистрации в Партнёрской программе.

API URI https://coincraddle.com/v1/api

Response type json

GET REQUESTS

`/validate-address` - Валидация адреса
Этот запрос определяет правильность введённого адреса

GET

https://coincraddle.com/v1/api/validate-address?key=3r8wzm4c8uo9ep5tk&currency=BTC&address=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
currency	`string`	`BTC`
address	`string`	`bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh`

Response 200

Successfull response

{
    "result":true
}

`/rate` - Получение курса на сумму обмена
Этот запрос получает текущий курс. Ставка не включает комиссию за транзакцию (майнер), взимаемую с каждой транзакции.

GET

https://coincraddle.com/v1/api/rate?key=3r8wzm4c8uo9ep5tk&from=BTC&to=USDT&amount=1&fix=0

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
from	`string`	`BTC`
to	`string`	`USDT`
amount	`float`	`1`
fix	`int 0 or 1`	`0`

Response 200

Successfull response

{
  "fix": false,
  "minamount": 0.02,
  "maxamount": 120,
  "rate": 16776.052484164,
  "withdrawalFee": 3.96626 USDT,
  "result": true
}

* fix: true - фиксированный курс, false - плавающий курс

* withdrawalFee: примерная комиссия за вывод. Плавающий параметр.

`/payment/rate` - Получение курса на сумму платежа
Данный запрос позволяет получить текущий курс обмена и рассчитать сумму средств, которую необходимо отправить для получения платежа.

GET

https://coincraddle.com/v1/api/payment/rate?key=3r8wzm4c8uo9ep5tk&from=BTC&to=USDT&amountTo=1000

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
from	`string`	`BTC`
to	`string`	`USDT`
amountTo	`float`	`1000`

Response 200

Successfull response

{
  "minamount": 0.02,
  "maxamount": 120,
  "rate": 0.04281856,
  "result": true
}

* rate: сумма средств, которую необходимо отправить

`/currencies` - Список валют
Этот запрос получает список всех доступных монет.

GET

https://coincraddle.com/v1/api/currencies?key=3r8wzm4c8uo9ep5tk

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`

Response 200

Successfull response

{
  "BTC": {
    "coinName": "Bitcoin",
    "minamount": 0.1,
    "maxamount": 120,
    "tagname": "",
    "network":"",
    "available": true
  },
  "USDT": {
    "coinName": "Tether USD",
    "minamount": 1678.66,
    "maxamount": 2757528,
    "tagname": "",
    "network":"erc20",
    "available": true
  },
 "ETC": {
    "coinName": "Ethereum Classic",
    "minamount": 102.51,
    "maxamount": 1021451,
    "tagname": "",
    "network":"",
    "available": true
  },
  "HBAR": {
    "coinName": "Hedera",
    "minamount": 34045.98,
    "maxamount": 39867109,
    "tagname": "MEMO",
    "network": "",
    "available": true
  },
  ...
}

Примечание

Если tagname не пустое значение, то для этой валюты тэг обязателен.

`/pairs` - Список всех пар
Этот запрос получает список всех доступных для обмена пар.

GET

https://coincraddle.com/v1/api/pairs?key=3r8wzm4c8uo9ep5tk

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`

Response 200

Successfull response

{
  "BTC": [
    "ZEC",
    "DAI",
    "USDT",
    "ETC",
    "BNB",
    "XRP"
  ],
  "XMR": [
    "USDC",
    "BTC",
    "USDT",
    "TUSD"
  ],
  "DASH": [
    "BTC",
    "USDT",
    "УЕР"
  ],
  "USDC": [
    "USDT",
    "ZEC"
  ],
  "LOOM": [
    "ETH",
    "PERL"
  ],
  "XRP": [
    "TRX"
  ],
  "ADA": [
    "USDT"
  ],
  "QTUM": [
    "BTC"
  ],
  ...
}

`/exchange-create` - Создание обмена
Этот запрос создаёт обмен.

GET

https://coincraddle.com/v1/api/exchange-create?key=3r8wzm4c8uo9ep5tk&from=BTC&to=ETH&amount=0.1&destinationAddress=0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh&fix=0

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
destinationAddress	`string`	`0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5`
destinationTagoptional	`string`
refundAddress	`string`	`bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh`
refundTagoptional	`string`
from	`string`	`BTC`
to	`string`	`ETH`
amount	`float`	`0.1`
fix	`int 0 or 1`	`0`

Response 200

Successfull response

{
    'id'             : '2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a',
    'depositAddress' : 'bc1qgdjqv0av3q56jvd82tkdjpy7gdp9ut8tlqmgrpmv24sq90ecnvqqjwvw97',
    'depositTag'     : '',
}

`/payment/exchange-create` - Создание платежа
Этот запрос создаёт платеж.

GET

https://coincraddle.com/v1/api/payment/exchange-create?key=3r8wzm4c8uo9ep5tk&from=BTC&to=ETH&amountTo=0.1&destinationAddress=0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
destinationAddress	`string`	`0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5`
destinationTagoptional	`string`
refundAddress	`string`	`bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh`
refundTagoptional	`string`
from	`string`	`BTC`
to	`string`	`ETH`
amountTo	`float`	`0.1`

Response 200

Successfull response

{
    'id'             : '2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a',
    'depositAddress' : 'bc1qgdjqv0av3q56jvd82tkdjpy7gdp9ut8tlqmgrpmv24sq90ecnvqqjwvw97',
    'depositTag'     : '',
}

`/payment/emergency` - Выбор действия с просроченным платежом
Выбор действия (продолжение обмена или возврат) для заказа в статусе `payment_time_expired`.

GET

https://coincraddle.com/v1/api/payment/emergency?key=3r8wzm4c8uo9ep5tk&id=2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a&needExchange=0&refundAddress=bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
id	`string`	`2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a`
needExchange	`int 0 or 1`	`0`
refundAddressoptional	`string`	`bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh`
refundTagoptional	`string`

Response 200

Successfull response

{
    "result": true
}

* needExchange: 1 — Продолжить обмен по рыночному курсу на момент выбора или на момент исправления ордера. 0 — Возврат средств за вычетом комиссии сети.

* refundAddress: Обязательный, если параметр "needExchange" = 0

`/exchange-status` - Получение статуса обмена
Получение информации о текущем статусе обмена

GET

https://coincraddle.com/v1/api/exchange-status?key=3r8wzm4c8uo9ep5tk&id=2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
id	`string`	`2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a`

Response 200

Successfull response

{
    'status'             : 'deposit_received',
    'from'               : 'BTC',
    'to'                 : 'USDT',
    'depositAddress'     : '1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
    'depositTag'         : '',
    'destinationAddress' : '0xDAFEA492D9c6733ae3d56b7Ed1ADB60692c98Bc5',
    'destinationTag'     : '',
    'refundAddress'      : 'bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh',
    'refundTag'          : '',
    'expectedAmountFrom' : '0.1',
    "expectedAmountTo"   : '5443.75908463',
    "amountFrom"         : '0.1',
    "date"               : '01.05.2021 10:24:30',
    "txId"               : null,
    "amountTo"           : null,
    "emergency"          : {
        "status"         : 'EXPIRED'
    }
    "result"             : true
}

Примечание

Список используемых статусов:
new - новый обмен (ожидание депозита)
waiting_deposit - подтверждение депозита
deposit_received - депозит получен
exchanging - в процессе обмена
sending - в процессе отправки
success - обмен успешно завершен
time_expired - вышло время ожидания средств
payment_time_expired - вышло время ожидания средств для проведения платежа
failed - обмен завершился с ошибкой
sending_failed - попытка отправки завершилась с ошибкой
reverted - клиенту были возвращены его средства
payment_halted - средства пришли, но обмен приостановлен

Список статусов для преостановленных ордеров:
EXPIRED - транзакция была получена после истечения срока действия ордера
LESS - транзакция была отправлена на сумму меньшую, чем в заказе

`/exchanges-status` - Получение статусов списка обменов
Получение информации о текущих статусах обменов

GET

https://coincraddle.com/v1/api/exchanges-status?key=3r8wzm4c8uo9ep5tk

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`

Headers Параметр

Параметр	Тип	Пример
ids	`array`	`['2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a', '3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k', '16257e7f-f9fc-4dbb-8ac7-63d0004b3064']`

Response 200

Successfull response

{
   "0":{
      "id":"2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a",
      "status":"time_expired",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxd30cf2e9dd32f987d7858d7e964bf173b7429547",
      "depositTag":"",
      "destinationAddress":"0xc406e35bbcec5dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593040aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"479",
      "expectedAmountTo":"440.26791571754",
      "amountFrom":null,
      "date":"19.09.2023 19:20:58",
      "txId":null,
      "amountTo":null
   },
   "1":{
      "id":"3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k",
      "status":"time_expired",
      "from":"TRX",
      "to":"USDTTRC20",
      "depositAddress":"TCQLDLUJ6iXaVx5ZYPUitgbsJietQmwXbu",
      "depositTag":"",
      "destinationAddress":"TLUQNgT28ha3hadx9CEptJeXrG7PeBaTC9",
      "destinationTag":"",
      "refundAddress":"TLUQNgT28ha3hadx9CEptJfXre7PeBaTC9",
      "refundTag":"",
      "expectedAmountFrom":"900",
      "expectedAmountTo":"71.689076",
      "amountFrom":null,
      "date":"12.09.2023 15:12:40",
      "txId":null,
      "amountTo":null
   },
   "2":{
      "id":"16257e7f-f9fc-4dbb-8ac7-63d0004b3064",
      "status":"success",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxfb212d7f1d5dba665c306f26d4bbcd83fdd77cf2",
      "depositTag":"",
      "destinationAddress":"0xc406e35bacec3dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593240aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"348.884502",
      "expectedAmountTo":307.0772074462869,
      "amountFrom":"348.86450200",
      "date":"13.09.2023 09:13:25",
      "txId":"0xf7ab1826c2a186ce596abf67a964716f30efa40c8e07c70d92ac297cc4c94b88",
      "amountTo":"306.43493965"
   },
   "result":true
}

Примечание

`/exchange-history` - Получение список всех обменов
Данный метод позволяет получить всю информацию по всем обменам

GET

https://coincraddle.com/v1/api/exchange-history?key=3r8wzm4c8uo9ep5tk

Параметр

Параметр	Тип	Пример
key	`string`	`3r8wzm4c8uo9ep5tk`
page	`int`	`0`
limit	`int`	`100 (max: 100)`

Response 200

Successfull response

{
   "exchanges":[{
      "id":"2a8ce4b6-ed5c-4c43-b4bd-ee2a9347fa7a",
      "status":"time_expired",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxd30cf2e9dd32f987d7858d7e964bf173b7429547",
      "depositTag":"",
      "destinationAddress":"0xc406e35bbcec5dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593040aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"479",
      "expectedAmountTo":"440.26791571754",
      "amountFrom":null,
      "date":"19.09.2023 19:20:58",
      "txId":null,
      "amountTo":null
   },
   {
      "id":"3b5sa1n8-ev7c-4c43-b5ud-aa2a9347fa6k",
      "status":"time_expired",
      "from":"TRX",
      "to":"USDTTRC20",
      "depositAddress":"TCQLDLUJ6iXaVx5ZYPUitgbsJietQmwXbu",
      "depositTag":"",
      "destinationAddress":"TLUQNgT28ha3hadx9CEptJeXrG7PeBaTC9",
      "destinationTag":"",
      "refundAddress":"TLUQNgT28ha3hadx9CEptJfXre7PeBaTC9",
      "refundTag":"",
      "expectedAmountFrom":"900",
      "expectedAmountTo":"71.689076",
      "amountFrom":null,
      "date":"12.09.2023 15:12:40",
      "txId":null,
      "amountTo":null
   },
   {
      "id":"16257e7f-f9fc-4dbb-8ac7-63d0004b3064",
      "status":"success",
      "from":"ICX",
      "to":"BAT",
      "depositAddress":"hxfb212d7f1d5dba665c306f26d4bbcd83fdd77cf2",
      "depositTag":"",
      "destinationAddress":"0xc406e35bacec3dc5c3576f159517bef0edc5ba98",
      "destinationTag":"",
      "refundAddress":"hx12b11f61c756609593240aa265e6bfb982b6f780",
      "refundTag":"",
      "expectedAmountFrom":"348.884502",
      "expectedAmountTo":307.0772074462869,
      "amountFrom":"348.86450200",
      "date":"13.09.2023 09:13:25",
      "txId":"0xf7ab1826c2a186ce596abf67a964716f30efa40c8e07c70d92ac297cc4c94b88",
      "amountTo":"306.43493965"
   }],
   "limit":100,
   "page":0,
   "result":true
}