IncoreX API

В целях безопасности при активации API происходит блокировка вывода средств на 48 часов.

Количество обращений к API методам ограничено 180 запросами в минуту с одного IP адреса либо от одного пользователя.

PUBLIC API

API доступное без авторизации HTTP методами GET или POST.

Общедоступное API не требует использования авторизации и доступно HTTP методами GET или POST.
Общий вид URL для доступа к API выглядит следующим образом https://api.incorex.com/v1/{api-name}?{api-params}
где api-name - это название API метода к которому происходит обращение
api-params - входящие параметры запроса (если они необходимы)

Описание методов:

Список сделок по валютной паре
Название метода: trades
HTTP метод запроса: POST / GET
Входящие параметры: pair - одна или несколько валютных пар разделенных запятой (пример BTC_USD,BTC_EUR)
Пример использования: https://api.incorex.com/v1/trades?pair=BTC_USD
Возращаемый ответ: { "BTC_USD": [ { "trade_id": 7569368, "type": 1, "quantity": "1", "price": "100", "amount": "100", "date": 1528129170 } ] }
Описание полей: trade_id - идентификатор сделки
type - тип сделки, где 0 - продажа, 1 - покупка
quantity - количество по сделке
price - цена сделки
amount - сумма сделки
date - дата и время сделки в формате
Список ордеров по валютной паре
Название метода: order_book
HTTP метод запроса: POST / GET
Входящие параметры: pair - одна или несколько валютных пар разделенных запятой (пример BTC_USD,BTC_EUR)
limit – кол-во отображаемых позиций (по умолчанию 100, максимум 1000)
Пример использования: https://api.incorex.com/v1/order_book?pair=BTC_USD
Возращаемый ответ: { "BTC_USD": { "ask": [["100","1","100"],["200","2","400"]], "bid": [["99","1","99"]], "ask_quantity": "3", "ask_amount": "500", "ask_top": "100", "bid_quantity": "1", "bid_amount": "99", "bid_top": "99" } }
Описание полей: ask - список ордеров на продажу, где каждая строка это цена, количество и сумма
bid - список ордеров на покупку, где каждая строка это цена, количество и сумма
ask_quantity - объем всех ордеров на продажу
ask_amount - сумма всех ордеров на продажу
ask_top - минимальная цена продажи
bid_quantity - объем всех ордеров на покупку
bid_amount - сумма всех ордеров на покупку
bid_top - максимальная цена покупки
Cтатистика цен и объемов торгов по валютным парам
Название метода: ticker
HTTP метод запроса: POST / GET
Входящие параметры: Нет
Пример использования: https://api.incorex.com/v1/ticker
Возращаемый ответ: { "BTC_USD": [ "BTC/USD", "7560.2", "7560.3", "52.02", "0.0069", "14235.04859805", "7599.7", "7372", 1528216450 ] }
Описание полей: Массив данных, где:
  1. название валютной пары
  2. текущая цена покупки
  3. текущая цена продажи
  4. разница цены за 24 часа
  5. разница цены в процентах за 24 часа
  6. последняя цена
  7. объем за 24 часа
  8. самая высокая цены за 24 часа
  9. самая низкая цены за 24 часа
  10. дата и время обновления данных в формате Unix
Настройки валютных пар
Название метода: pair_settings
HTTP метод запроса: POST / GET
Входящие параметры: Нет
Пример использования: https://api.incorex.com/v1/pair_settings
Возращаемый ответ: { "BTC_USD": { "min_quantity":"0.002", "max_quantity":"100", "min_price":"0.01", "max_price":"100", "min_amount":"0.01", "max_amount":"300" } }
Описание полей: min_quantity - минимальное количество по ордеру
max_quantity - максимальное количество по ордеру
min_price - минимальная цена по ордеру
max_price - максимальная цена по ордеру
min_amount - минимальная сумма по ордеру
max_amount - максимальная сумма по ордеру
Cписок валют биржи
Название метода: currency
HTTP метод запроса: POST / GET
Входящие параметры: Нет
Пример использования: https://api.incorex.com/v1/currency
Возращаемый ответ: ["EUR","USD","PLN","RUB","BTC","BCH","DASH","ETH","ETC","LTC","XMR"]
AUTHENTICATED API

API запросы достуны только HTTP методом POST с использованием авторизации.

Все API методы достуны только через HTTP POST.

Общий вид URL для доступа к API выглядит следующим образом https://api.incorex.com/v1/{api-name}
где api-name - это название API метода к которому происходит обращение

Авторизация всех отправляемых запросов осуществляется с помощью отправки на сервер HTTP headers/заголовков:

Key — API Key доступный в настройках профиля пользователя
(пример: d876ff8da67c3731ae25d8335a4168b4)

Sign — Хэш POST данных (param=val&param1=val1), подписанные секретным ключом методом HMAC-SHA512. Секретный ключ (API Secret) доступный в настройках профиля пользователя
(пример: hash_hmac('sha512', 'param=val&param1=val1', '1ddec0f92f297e937bdf409977df0c02'))

Во всех запросах должен находиться обязательный POST-параметр nonce с инкрементным числовым значением (>0). Это значение не должно повторяться или уменьшаться.

Готовые примеры работы с API на разных языках программирования:
PHP github.com/incorex-dev/incorex-api-lib/tree/master/php
JavaScript github.com/incorex-dev/incorex-api-lib/tree/master/js
Node.js github.com/incorex-dev/incorex-api-lib/tree/master/nodejs
C# github.com/incorex-dev/incorex-api-lib/tree/master/c#
C++ github.com/incorex-dev/incorex-api-lib/tree/master/c++
Python github.com/incorex-dev/incorex-api-lib/tree/master/python
Java github.com/incorex-dev/incorex-api-lib/tree/master/java
Ruby github.com/incorex-dev/incorex-api-lib/tree/master/ruby
Golang github.com/incorex-dev/incorex-api-lib/tree/master/golang

Описание методов:

Информация об аккаунте пользователя
Название метода: user_info
HTTP метод запроса: POST
Входящие параметры: Нет
Пример использования на PHP: api_query("user_info", Array());
Возращаемый ответ: { "uid": 10542, "server_time": 1435518576, "balances": { "BTC": "970.994", "USD": "949.47" }, "reserved": { "BTC": "3", "USD": "0.5" } }
Описание полей: uid - идентификатор пользоватля
server_time - дата и время сервера в формате Unix
balances - доступный баланс пользователя
reserved - баланс пользователя в ордерах
Создание ордера
Название метода: order_create
HTTP метод запроса: POST
Входящие параметры: pair - валютная пара
quantity – количество по ордеру
price – цена по ордеру
position – позиция ордера, может принимать следующие значения:
  • buy - ордер на покупку
  • sell - ордер на продажу
type – тип ордера, может принимать следующие значения:
  • limit - отложенный ордер, который будет выполнен при достижении цены
  • market - ордер по текущей цене
  • stoplimit - отложенный ордер, который будет выполнен когда наивысшая цена покупки или самая низкая цена продажи достигает определённого значения цен stoplimit/price
limitprice – максимальная/минимальная (в зависимости от значения position: buy/sell) цена по ордеру, (обязательный параметр при type: stoplimit)
Пример использования на PHP: api_query("order_create", Array( "pair" => "BTC_USD", "quantity" => 1, "price" => 100, "position" => "buy", "type" => "market" ));
Возращаемый ответ: { "name": "order_create", "status": "ok", "id": 0, "msg": "Ok", "order_id": 123456 }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
order_id - идентификатор ордера
Отмена ордера
Название метода: order_cancel
HTTP метод запроса: POST
Входящие параметры: order_id - идентификатор ордера
Пример использования на PHP: api_query("order_cancel", Array( "order_id" => 123456 ));
Возращаемый ответ: { "name": "order_cancel", "status": "ok", "id": 0, "msg": "Ok" }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
Список открытых ордеров пользователя
Название метода: user_open_orders
HTTP метод запроса: POST
Входящие параметры: Нет
Пример использования на PHP: api_query("user_open_orders", Array());
Возращаемый ответ: { "BTC_USD": [ { "date": 1528117470, "order_id": 123456, "pair": "BTC_USD", "position": 0, "type": "market", "quantity": "1", "price": "100", "amount": "100" } ] }
Описание полей: date - дата и время создания ордера в формате Unix
order_id - идентификатор ордера
pair - валютная пара
position - позиция ордера, где 0 - продажа, 1 - покупка
type - тип ордера(limit/market/stoplimit),
limitprice - для типа ордера stoplimit,
quantity - количество по ордеру
price - цена по ордеру
amount - сумма по ордеру
Список сделок пользователя
Название метода: user_trades
HTTP метод запроса: POST
Входящие параметры: pair - одна или несколько валютных пар разделенных запятой (пример BTC_USD,BTC_EUR)
offset - смещение от последней сделки (по умолчанию 0)
limit - количество возвращаемых сделок (по умолчанию 100, максимум 10 000)
Пример использования на PHP: api_query("user_trades", Array( "pair" => "BTC_USD", "offset" => 0, "limit" => 100 ));
Возращаемый ответ: { "BTC_USD": [ { "trade_id": 123456, "date": 1435488248, "type": 1, "pair": "BTC_USD", "order_id": 123456, "quantity": 1, "price": 100, "amount": 100 } ] }
Описание полей: trade_id - идентификатор сделки
date - дата и время сделки в формате Unix
type - тип сделки, где 0 - продажа, 1 - покупка
pair - валютная пара
order_id - идентификатор ордера пользователя
quantity - количество по сделке
price - цена сделки
amount - сумма сделки
Список отмененных ордеров пользователя
Название метода: user_cancelled_orders
HTTP метод запроса: POST
Входящие параметры: offset - смещение от последней сделки (по умолчанию 0)
limit – количество возвращаемых сделок (по умолчанию 100, максимум 10 000)
Пример использования на PHP: api_query("user_cancelled_orders", Array( "offset" => 0, "limit" => 100 ));
Возращаемый ответ: [ { "date": 1435519742, "order_id": 123456, "pair": "BTC_USD", "position": 1, "type": "market", "quantity": 3, "price": 100, "amount": 300 } ]
Описание полей: date - дата и время отмены ордера в формате Unix
order_id - идентификатор ордера
pair - валютная пара
position - позиция ордера, где 0 - продажа, 1 - покупка
type - тип ордера, где
  • limit - отложенный ордер, который будет выполнен при достижении цены
  • market - ордер по текущей цене
  • stoplimit - отложенный ордер, который будет выполнен когда наивысшая цена покупки или самая низкая цена продажи достигает определённого значения цен stoplimit/price
quantity - количество по ордеру
price - цена по ордеру
amount - сумма по ордеру
Истории сделок по ордеру
Название метода: order_trades
HTTP метод запроса: POST
Входящие параметры: order_id - идентификатор ордера
Пример использования на PHP: api_query("order_trades", Array( "order_id" => 123456 ));
Возращаемый ответ: { "position": 0, "type": "market", "in_currency": "BTC", "in_amount": "1", "out_currency": "USD", "out_amount": "100", "percent_succesfull": 100, "trades": [ { "trade_id": 123456, "date": 1435488248, "type": 0, "pair": "BTC_USD", "order_id": 123456, "quantity": 1, "price": 100, "amount": 100 } ] }
Описание полей: position - позиция ордера, где 0 - продажа, 1 - покупка
type - тип ордера, где
  • limit - отложенный ордер, который будет выполнен при достижении цены
  • market - ордер по текущей цене
  • stoplimit - отложенный ордер, который будет выполнен когда наивысшая цена покупки или самая низкая цена продажи достигает определённого значения цен stoplimit/price
in_currency - валюта входящая
in_amount - сумма входящей валюты
out_currency - валюта исходящая
out_amount - сумма исходящей валюты
percent_succesfull - процент выполнения ордера
trades - массив сделок, где:
  • trade_id - идентификатор сделки
  • date - дата сделки в формате Unix
  • type - тип сделки, где 0 - продажа, 1 - покупка
  • pair - валютная пара
  • order_id - идентификатор ордера
  • quantity - количество по сделке
  • price - цена по сделке
  • amount - сумма по сделке
Подсчет суммы в какую обойдется покупка определенного количества валюты по конкретной валютной паре
Название метода: required_amount
HTTP метод запроса: POST
Входящие параметры: pair - валютная пара
quantity – количество которое необходимо купить
Пример использования на PHP: api_query("required_amount", Array( "pair" => "BTC_USD", "quantity" => "0.5" ));
Возращаемый ответ: { "quantity": "0.5", "amount": "3500.00", "avg_price": "3.66666666" }
Описание полей: quantity - количество покупки
amount - сумма на которую вы потратите на покупку
avg_price - средняя цена покупки
Список адресов для депозита криптовалют
Название метода: deposit_address
HTTP метод запроса: POST
Входящие параметры: Нет
Пример использования на PHP: api_query("deposit_address", Array());
Возращаемый ответ: { "BTC": "...", "BCH": "...", "LTC": "...", "ETH": "...." }
Создание заявки на вывод криптовалют ВНИМАНИЕ! Этот API метод включается пользователю после запроса в техподдержку
Название метода: withdraw_crypt
HTTP метод запроса: POST
Входящие параметры: amount - сумма выводимой валюты
currency – наименование выводимой валюты
address – адрес вывода
Пример использования на PHP: api_query("withdraw_crypt", Array( "amount" => 0.5, "currency" => "BTC", "address" => "..." ));
Возращаемый ответ: { "name": "withdraw_crypt", "status": "ok", "id": 0, "msg": "Ok", "task_id": "123456" }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
task_id - идентификатор заявки на вывод
Получение ID транзакции криптовалюты для отслеживания в blockchain
Название метода: withdraw_get_txid
HTTP метод запроса: POST
Входящие параметры: task_id - идентификатор заявки на вывод
Пример использования на PHP: api_query("withdraw_get_txid", Array( "task_id" => 123456 ));
Возращаемый ответ: { "name": "withdraw_get_txid", "status": "ok", "id": 0, "msg": "Ok", "txid": "..." }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
status - true если заявка на вывод уже выполнена
txid - идентификатор транзакции по которому можно ее найти в blockchain. Если содержит пустое значение - заявка еще не обработана
X-VOUCHER API

Приватные функции доступные только с авторизацией. Для активации данных методов необходимо обратиться в техподдержку.

Используя методы X-VOUCHER API можно создавать и активировать ваучеры X-VOUCHER Эти API методы включаются пользователю после запроса в техподдержку
Создание ваучера X-VOUCHER
Название метода: create_xvoucher
HTTP метод запроса: POST
Входящие параметры: currency - наименование валюты ваучера
amount – сумма ваучера
Пример использования на PHP: api_query("create_xvoucher", Array( "currency" => "BTC", "amount" => 0.5 ));
Возращаемый ответ: { "name": "create_xvoucher", "status": "ok", "id": 0, "msg": "Ok", "task_id": "123456", "code": "X-VOUCHER-CODE...", "amount": "0.5", "currency": "BTC", "balances": { "BTC": 1, "USD": 1000 } }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
task_id - идентификатор ваучера
code - ваучер X-VOUCHER
amount - сумма ваучера
currency - валюта ваучера
balances - баланс пользователя после создания ваучера
Активация ваучар X-VOUCHER
Название метода: activate_xvoucher
HTTP метод запроса: POST
Входящие параметры: code - ваучер X-VOUCHER
Пример использования на PHP: api_query("activate_xvoucher", Array( "code" => "X-VOUCHER-CODE..." ));
ваучер X-VOUCHER: { "name": "activate_xvoucher", "status": "ok", "id": 0, "msg": "Ok", "amount": "0.5", "currency": "BTC" }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
amount - сумма ваучера
currency - валюта ваучера
WALLET API

API запросы достуны только HTTP методом POST с использованием авторизации. Для активации данных методов необходимо обратиться в техподдержку.

Количество обращений к API методам ограничено 10 запросами в минуту с одного IP адреса.
История операций по кошельку
Название метода: wallet_history
HTTP метод запроса: POST
Входящие параметры: date - дата в формате Unix (timestamp) за которую нужно получить историю операций (если не указан берется текущий день)
Пример использования на PHP: api_query("wallet_history", Array( "date" => 1528239599 ));
Возращаемый ответ: { "name": "wallet_history", "status": "ok", "id": 0, "msg": "Ok", "begin": "1528239600", "end": "1528325999", "history": [ { "date": 1528239600, "currency": "USD", "type": "deposit", "amount": "100", "fee": "1", "paysystem": "Perfect money", "account": "", "txid": "", "status": "processing" }, { "date": 1528239600, "currency": "XMR", "type": "withdrawal", "amount": "0.15000000", "fee": "0.05000000", "paysystem": "Monero", "account": "...", "txid": "...", "status": "processing" } ] }
Описание полей: name - название API метода
status - ok в случае успешного создания и error в случае ошибки
id - содержит идентификатор ошибки
msg - содержит текст ошибки
begin - начало периода в формате Unix
end - конец периода в формате Unix
history - массив операций пользователя (история операций), где
  • date - дата операции в формате Unix
  • currency - валюта операции
  • type - тип операции
  • amount - сумма сделки
  • fee - комиссия
  • paysystem - провайдер
  • account - счет
  • txid - идентификатор транзакции по которому можно ее найти в blockchain
  • status - статус
Продолжая просматривать , вы подтверждаете, что ознакомились с Пользовательским соглашением, и соглашаетесь c Политика конфиденциальности.