Публічні методи API

Існує 6 публічних методів, які беруть HTTP GET запити і повертають результат у JSON форматі:

ReturnTicker

Повертає тікери для всіх / зазначених маркетів, приклад запиту та відповіді:

Приклад 1. Повернення всіх токарів.

Виклик: https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnTicker

Результат:

{
  Tickers: [{
    BaseVolume: "0.00000000",
    HighPrice: "0.09611615",
    Last: "0.05125186",
    LowPrice: "0.04456261",
    ...
  },  {
    BaseVolume: "0.00000000",
    HighPrice: "0.02062280",
    Last: "0.01025148",
    LowPrice: "0.00972667",
    ...
  },  {
    BaseVolume: "0.00000000",
    HighPrice: "0.00105385",
    Last: "0.00050066",
    LowPrice: "0.00040122",
    ...
  },  ...]
}

Приклад 2. Повернення тікера BTC_LTC і BTC_DOGE.

Виклик: https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnTicker?request=[NamePairs=BTC_LTC,BTC_DOGE]

Результат:

{
  Tickers:  [{
    BaseVolume: "0.00000000",
    HighPrice: "0.02062280",
    Last: "0.01023842",
    LowPrice: "0.00972667",
    ...
  },  {
    BaseVolume: "0.47617000",
    HighPrice: "0.00000080",
    Last: "0.00000041",
    LowPrice: "0.00000035",
    ...
  }]
}


Return24Volume

Повертає обсяг торгів за 24 години для всіх / зазначених маркетів:

Приклад. Повернення обсягів для пари BTC_DOGE.

Виклик:https://api.crex24.com/CryptoExchangeService/BotPublic/Return24Volume?request=[NamePairs=BTC_DOGE]

Результат:

{
  Volume: {
    VolumesByOne: [{
      Name: "BTC",
      Volume: 0.23673
    }, {
      Name: "DOGE",
      Volume: 577000
    }],
    VolumesByTwo: [{
      First: {
        Name: "BTC",
        Volume: 0.23673
      },
      Name: "BTC_DOGE",
      Second: {
        Name: "DOGE",
        Volume: 577000
      }
    }]
  }
}


ReturnOrderBook

Повертає стек ордерів для зазначеного маркету

Приклад. Повернення стека ордерів для пари BTC_DOGE.

Виклик:https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnOrderBook?request=[PairName=BTC_DOGE]

Результат:

{
  BuyOrders: [{
    AccumulateMoneyCount: "36826.27800846",
    AccumulateMoneyVolume: "0.01509877",
    CoinCount: "36826.27800846",
    ...
  },  {
    AccumulateMoneyCount: "67304.76798074",
    AccumulateMoneyVolume: "0.02729017",
    CoinCount: "30478.48997228",
    ...
  },  {
    AccumulateMoneyCount: "75084.76074510",
    AccumulateMoneyVolume: "0.03032437",
    CoinCount: "7779.99276436",
    ...
  },  {
    AccumulateMoneyCount: "75433.94286209",
    AccumulateMoneyVolume: "0.03045706",
    CoinCount: "349.18211699",
    ...
  }],
  SellOrders: [{
    AccumulateMoneyCount: "10642.66536957",
    AccumulateMoneyVolume: "0.00446992",
    CoinCount: "10642.66536957",
    ...
  },  {
    AccumulateMoneyCount: "31738.44031685",
    AccumulateMoneyVolume: "0.01354110",
    CoinCount: "21095.77494728",
    ...
  }, {
    AccumulateMoneyCount: "41156.60557210",
    AccumulateMoneyVolume: "0.01768510",
    CoinCount: "9418.16525525",
    ...
  }, {
    AccumulateMoneyCount: "50937.97566773",
    AccumulateMoneyVolume: "0.02208671",
    CoinCount: "9781.37009563",
    ...
  }]
}


ReturnTradeHistoryPub

Повертає 1000 (або менше якщо вказано параметр Count) останніх угод або угод за час, заданий параметрами StartTS і EndTS в форматі UNIX timestamp.

Приклад. Повернення історії угод для пари BTC_DOGE.

Виклик:https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnTradeHistoryPub?request=[PairName=BTC_DOGE]

Результат:

{
  Trades: [{
    CoinCount: "716.23394813",
    CoinPrice: "0.00000037",
    Commission: "0.00000027",
    DtCreateTS: 1502771794,
    ...
  }, {
    CoinCount: "283.76605187",
    CoinPrice: "0.00000037",
    Commission: "0.00000010",
    DtCreateTS: 1502771794,
    ...
  }]
}


ReturnChartData

Повертає дані по свічках для заданого маркету. Час свічок в хвилинах може бути задано параметром CandleTimeInMinutes, початок і закінчення інтервалу може бути задано параметрами StartTS і EndTS в форматі UNIX timestamp.

Приклад. Повертає дані денного графіка котирувань з 1 по 31 січня 2019 року по маркету BTC_DOGE.

Виклик:https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnChartData?request=[PairName=BTC_DOGE][CandleTimeInMinutes=1440][StartTS=1546300800][EndTS=1548892800]

Результат:

{
  Candles:  [{
    EndOrderPrice: "0.00000099",
    MaxOrderPrice: "0.00000100",
    MinOrderPrice: "0.00000098",
    OrderCount: 4,
    ...
  },  {
    EndOrderPrice: "0.00000100",
    MaxOrderPrice: "0.00000101",
    MinOrderPrice: "0.00000099",
    OrderCount: 2,
    ...
  },  {
    EndOrderPrice: "0.00000102",
    MaxOrderPrice: "0.00000103",
    MinOrderPrice: "0.00000100",
    OrderCount: 4 ,
    ...
  },  ...]
}


ReturnCurrencies

Повертає інформацію про всіх/зазначених валютах.

Приклад. Інформація про валюту DOGE

Виклик:https://api.crex24.com/CryptoExchangeService/BotPublic/ReturnCurrencies?request=[Names=DOGE]

Результат:

{
  Currencies: [{
    Delisted: false,
    Disabled: false,
    Frozen: false,
    MinConf: 6,
    Name: "Dogecoin",
    ...
  }]
}

Торгові методи API

Url для trading API: https://api.crex24.com/CryptoExchangeService/BotTrade/<MethodName>

Для використання trading API необхідно створити API key(https://crex24.com/settings/tokens).

Будь ласка, враховуйте що ліміт за замовчуванням - 6 запитів в секунду. Якщо цього недостатньо, звертайтеся в службу підтримки для обговорення збільшення ліміту.

Всі запити trading API надсилаються на HTTP адреса методом POST і повинні містити такі заголовки:
  • UserKey — API key.
  • Sign - Підпис тіла POST запиту, створена за допомогою секретного ключа методом HMACSHA512.

Додатково, всі запити повинні містити POST параметр Nonce. Nonce - це unsigned int64, яке завжди повинно бути більше, ніж попереднє використане значення. Для цих цілей можна використовувати поточний timestamp.

Відповідь надсилається в JSON форматі. Якщо трапляється помилка, то відповідь буде в такому форматі:

{"Error" : {"Message" : "<error message>"}}

Приклади відправки запитів до торгового API на різних мовах програмування:

Readme: https://github.com/iiw/Crex24.Examples

Python: https://github.com/iiw/Crex24.Examples/blob/master/python/app.py

C#: https://github.com/3P3C/Crex24.Example/blob/master/Crex24Example/Program.cs

JS: https://github.com/iiw/Crex24.Examples/tree/master/js

PHP: https://github.com/iiw/Crex24.Examples/blob/master/php/app.php

ReturnBalances

Отримати доступні баланси.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnBalances

Тіло запиту:

{
    "Names" : ["BTC", "LTC"],    # Список валют. Якщо відсутня, то отримати по всіх валютах.
    "NeedNull" : "true"          # чи включати до списку нульові баланси.
}

Відповідь:

{
  "Balances": [
    {
      "AvailableBalances": 10.00000000,
      "InOrderBalances": 10.00000000,
      "Name": "BTC"
    },
    {
      "AvailableBalances": 0.00000000,
      "InOrderBalances": 0.00000000,
      "Name": "LTC"
    }
  ]
}

ReturnOpenOrders

Отримати відкриті ордера.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnOpenOrders

Тіло запиту:

{
  "Pairs": ["BTC_LTC", "BTC_ETH"]    # Список торгових пар. Якщо відсутня, то отримати по всіх торгових парам.
}

Відповідь:

{
  "Orders": [
    {
      "CoinCount": 1.00000000,
      "CoinPrice": 0.01135442,
      "Id": 71463796,
      "IsCloseRequired": false,
      "IsSell": true,
      "PairName": "BTC_LTC"
    },
    {
      "CoinCount": 1.00000000,
      "CoinPrice": 0.06835904,
      "Id": 71463169,
      "IsCloseRequired": false,
      "IsSell": true,
      "PairName": "BTC_ETH"
    },
    ...
  ]
}

ReturnTradeHistory

Отримати торгову історію.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnTradeHistory

Тіло запиту:

{
  "Pairs": ["BTC_LTC", "BTC_ETH"]   # Список торгових пар. Якщо відсутня, то отримати по всіх торгових парам.
}

Відповідь:

{
  "Trades": [
    {
      "CoinCount": 1.00000000,
      "CoinPrice": 0.06835904,
      "Commission": 0.00000166,
      "DtCreateTS": 1506517638,
      "Id": 185197,
      "IsMaker": true,
      "IsSell": true,
      "PairName": "BTC_ETH"
    },
    {
      "CoinCount": 1.00000000,
      "CoinPrice": 0.01135442,
      "Commission": 0.00000166,
      "DtCreateTS": 1506085177,
      "Id": 185169,
      "IsMaker": true,
      "IsSell": false,
      "PairName": "BTC_LTC"
    },
    ...
  ]
}

ReturnOrderTrades

Отримати всі торгові операції по ордеру.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnOrderTrades

Тіло запиту:

{
  "OrderId": 51893150
}

Відповідь:

{
  "Trades": [
    {
      "CoinCount": 10.00000000,
      "CoinPrice":  0.06835904,
      "Commission": 0.00000166,
      "DtCreateTS": 1506517638,
      "Id": 185197,
      "IsMaker": true,
      "IsSell": true,
      "PairName": "BTC_ETH"
    },
    ...
  ]
}

Buy

Виставити ордер на покупку.

Приклад. Виставити ордер на покупку 10 LTC за BTC за ціною 0.01194538:

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/Buy

Тіло запиту:

{
  "Pair": "BTC_LTC",
  "Course": 0.01194538,
  "Volume": 10.0
}

Відповідь:

{
  "Id": 51893288
}

Sell

Виставити ордер на продаж.

Приклад. Виставити ордер на продаж 10 LTC за BTC за ціною 0.01194538:

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/Sell

Тіло запиту:

{
  "Pair": "BTC_LTC",
  "Course": 0.01194538,
  "Volume": 10.0
}

Відповідь:

{
  "Id": 51893294
}

CancelOrder

Скасувати ордер.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/CancelOrder

Тіло запиту:

{
  "OrderId": 51893294
}

Відповідь:

{
  "Success": true
}

CancelOrderMulti

Скасувати кілька ордерів за списком id або по торговим парам.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/CancelOrderMulti

Приклад 1. Скасувати ордера за списком id:

Тіло запиту:

{
  "OrderIds": [51893293, 51893292]
}

Приклад 2. Скасувати всі ордера по торговим парам:

Тіло запиту:

{
  "PairNames": ["BTC_ETH", "BTC_LTC"]
}

Відповідь:

{
  "Success": true
}

ReturnOrderStatus

Отримати інформацію і всі торгові операції по ордеру.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnOrderStatus

Тіло запиту:

{
  "OrderId": 51893312
}

Відповідь:

{
  "CurrentOrder": {               # Поточний стан ордера.
    "CoinCount": 9.00000000,
    "CoinPrice": 0.01194538,
    "Id": 51893314,
    "IsCloseRequired": false,
    "IsSell": false,
    "PairName": "BTC_LTC"
  },
  "SourceOrder": {                # Початковий стан ордера.
    "CoinCount": 10.00000000,
    "CoinPrice": 0.01194538,
    "Id": 51893314,
    "IsCloseRequired": false,
    "IsSell": false,
    "PairName": "BTC_LTC"
  },
  "Trades": [                     # Список торгових операцій по ордеру.
    {
      "CoinCount": 1.00000000,
      "CoinPrice": 0.01194538,
      "Commission": 0.00000000,
      "DtCreateTS": 1507465556,
      "Id": 185250,
      "IsMaker": true,
      "IsSell": false,
      "PairName": "BTC_LTC"
    }
  ]
}

ReturnDepositsWithdrawals

Отримати історію по депозитах і висновків. Використовується посторінковий висновок, починаючи з останніх транзакцій. Для отримання наступної сторінки необхідно заповнити поле FromId мінімальним Id записи з попередньої відповіді.

Приклад. Отримати останні 100 записів:

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnDepositsWithdrawals

Тіло запиту:

{
  "Names": ["BTC", "LTC"],       # Список валют. Якщо відсутня, то отримати по всіх валютах.
  "FromId": 0,                   # 0 або мінімальний Id записи з попередньої відповіді.
  "Take": 100                    # Кількість записів, необхідних повернути. Максимальна кількість записів - 1000.
}

Відповідь:

{
  "CountRemain": 1000,                          # Кількість залишилися записів. Якщо 0 - то це остання сторінка.
  "Changes": [
    {
      "Address": "17XjwyX78jusTPXHxxF14ST9fWrCUcLT6L",   # Адреса платежу.
      "AgentName": null,                        # Ім'я платіжної системи для фіатних валют.
      "CurrenceName": "BTC",
      "Id": 151,                                # Id записи.
      "NeedConfirm": 15,
      "NumConfirm": 17,
      "Status": 3,                              # Статус платежу. Див. нижче.
      "Sum": 0.20000000,
      "TimeTs": 1504100143,                     # Час створення запису в utc форматі.
      "TxId": "4f37855e4ecfc8f15b58f3397a6f339ca6f941d63d097c08004f7c9dfc4ec700",   # Id транзакції.
      "Type": 2                                 # Тип запису. Див. нижче.
    },
    ...
  ],
}

Можливі значення поля «Status»:
  1. - Підтверджено користувачем
  2. - Транзакція створена
  3. - Перше підтвердження
  4. - Успішна обробка
  5. - Транзакція відхилена
  6. - В процесі обробки
  7. - Скасовано користувачем
  8. - Очікування відправки
Можливі значення поля «Type»:
  1. - Депозит криптовалюти
  2. - Вивід криптовалюти
  3. - Депозит фіатной валюти
  4. - Висновок фіатной валют

Withdraw

Створити запит на висновок.

Приклад.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/Withdraw

Тіло запиту:

{
  "Currency": "BTC",
  "Sum": 1.0,
  "Address": "17XjwyX78jusTPXHxxF14ST9fWrCUcLT6L",
  "Message": "any_message"         # Повідомлень для транзакції (буде відправлено якщо валюта підтримує).
}

Відповідь:

{
  "NewBalance": 9.00000000,                         # Новий баланс.
  "OutId": 613                                      # Id запиту на виведення. Якщо не 0 - то запит успішно створений.
}

ReturnDepositAddress

Отримати адресу для поповнення валюти. Якщо для поповнення необхідно вказати повідомлення, то воно буде присутній у відповіді.

Запит: https://api.crex24.com/CryptoExchangeService/BotTrade/ReturnDepositAddress

Приклад 1. Отримати адресу для поповнення BTC:

Тіло запиту:

{
  "Currency": "BTC"
}

Відповідь:

{
  "Address": "1JH6h3qDbAMEzAD8e7usWEqePddHzpSTgK",
  "Message": null 
}

Приклад 2. Отримати адресу для поповнення XMR:

Тіло запиту:

{
  "Currency": "XMR"
}

Відповідь:

{
  "Address": "NC6GOUR4ICVVPPK7N4UIYWDJM6LTUBJFR7OVXDS5",
  "Message": "950a239c0f98ca41"                             # Повідомлення яке необхідно вказати при поповненні.
}