В целях безопасности при активации API происходит блокировка вывода средств на 48 часов.
Количество обращений к API методам ограничено 180 запросами в минуту с одного IP адреса либо от одного пользователя.
API доступное без авторизации HTTP методами GET или POST.
Название метода: | trades |
HTTP метод запроса: | POST / GET |
Входящие параметры: | pair - одна или несколько валютных пар разделенных запятой (пример BTC_USD,BTC_EUR) |
Пример использования: | https://api.incorex.com/v1/trades?pair=BTC_USD |
Возращаемый ответ: |
|
Описание полей: |
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 |
Возращаемый ответ: |
|
Описание полей: |
ask - список ордеров на продажу, где каждая строка это цена, количество и сумма bid - список ордеров на покупку, где каждая строка это цена, количество и сумма ask_quantity - объем всех ордеров на продажу ask_amount - сумма всех ордеров на продажу ask_top - минимальная цена продажи bid_quantity - объем всех ордеров на покупку bid_amount - сумма всех ордеров на покупку bid_top - максимальная цена покупки |
Название метода: | ticker |
HTTP метод запроса: | POST / GET |
Входящие параметры: | Нет |
Пример использования: | https://api.incorex.com/v1/ticker |
Возращаемый ответ: |
|
Описание полей: | Массив данных, где:
|
Название метода: | pair_settings |
HTTP метод запроса: | POST / GET |
Входящие параметры: | Нет |
Пример использования: | https://api.incorex.com/v1/pair_settings |
Возращаемый ответ: |
|
Описание полей: |
min_quantity - минимальное количество по ордеру max_quantity - максимальное количество по ордеру min_price - минимальная цена по ордеру max_price - максимальная цена по ордеру min_amount - минимальная сумма по ордеру max_amount - максимальная сумма по ордеру |
Название метода: | currency |
HTTP метод запроса: | POST / GET |
Входящие параметры: | Нет |
Пример использования: | https://api.incorex.com/v1/currency |
Возращаемый ответ: |
|
API запросы достуны только HTTP методом POST с использованием авторизации.
Все API методы достуны только через HTTP POST.
Авторизация всех отправляемых запросов осуществляется с помощью отправки на сервер HTTP headers/заголовков:
Key — API Key доступный в настройках профиля пользователя
(пример: d876ff8da67c3731ae25d8335a4168b4)
Sign — Хэш POST данных (param=val¶m1=val1), подписанные секретным ключом методом HMAC-SHA512. Секретный ключ (API Secret) доступный в настройках профиля пользователя
(пример: hash_hmac('sha512', 'param=val¶m1=val1', '1ddec0f92f297e937bdf409977df0c02'))
Во всех запросах должен находиться обязательный POST-параметр nonce с инкрементным числовым значением (>0). Это значение не должно повторяться или уменьшаться.
Название метода: | user_info |
HTTP метод запроса: | POST |
Входящие параметры: | Нет |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
uid - идентификатор пользоватля server_time - дата и время сервера в формате Unix balances - доступный баланс пользователя reserved - баланс пользователя в ордерах |
Название метода: | order_create |
HTTP метод запроса: | POST |
Входящие параметры: |
pair - валютная пара quantity – количество по ордеру price – цена по ордеру position – позиция ордера, может принимать следующие значения:
|
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки order_id - идентификатор ордера |
Название метода: | order_cancel |
HTTP метод запроса: | POST |
Входящие параметры: | order_id - идентификатор ордера |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки |
Название метода: | user_open_orders |
HTTP метод запроса: | POST |
Входящие параметры: | Нет |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
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: |
|
Возращаемый ответ: |
|
Описание полей: |
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: |
|
Возращаемый ответ: |
|
Описание полей: |
date - дата и время отмены ордера в формате Unix order_id - идентификатор ордера pair - валютная пара position - позиция ордера, где 0 - продажа, 1 - покупка type - тип ордера, где
price - цена по ордеру amount - сумма по ордеру |
Название метода: | order_trades |
HTTP метод запроса: | POST |
Входящие параметры: | order_id - идентификатор ордера |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
position - позиция ордера, где 0 - продажа, 1 - покупка type - тип ордера, где
in_amount - сумма входящей валюты out_currency - валюта исходящая out_amount - сумма исходящей валюты percent_succesfull - процент выполнения ордера trades - массив сделок, где:
|
Название метода: | required_amount |
HTTP метод запроса: | POST |
Входящие параметры: |
pair - валютная пара quantity – количество которое необходимо купить |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
quantity - количество покупки amount - сумма на которую вы потратите на покупку avg_price - средняя цена покупки |
Название метода: | deposit_address |
HTTP метод запроса: | POST | Входящие параметры: | Нет |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Название метода: | withdraw_crypt |
HTTP метод запроса: | POST | Входящие параметры: |
amount - сумма выводимой валюты currency – наименование выводимой валюты address – адрес вывода |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки task_id - идентификатор заявки на вывод |
Название метода: | withdraw_get_txid |
HTTP метод запроса: | POST |
Входящие параметры: | task_id - идентификатор заявки на вывод |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки status - true если заявка на вывод уже выполнена txid - идентификатор транзакции по которому можно ее найти в blockchain. Если содержит пустое значение - заявка еще не обработана |
Приватные функции доступные только с авторизацией. Для активации данных методов необходимо обратиться в техподдержку.
Название метода: | create_xvoucher |
HTTP метод запроса: | POST |
Входящие параметры: |
currency - наименование валюты ваучера amount – сумма ваучера |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки task_id - идентификатор ваучера code - ваучер X-VOUCHER amount - сумма ваучера currency - валюта ваучера balances - баланс пользователя после создания ваучера |
Название метода: | activate_xvoucher |
HTTP метод запроса: | POST |
Входящие параметры: | code - ваучер X-VOUCHER |
Пример использования на PHP: |
|
ваучер X-VOUCHER: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки amount - сумма ваучера currency - валюта ваучера |
API запросы достуны только HTTP методом POST с использованием авторизации. Для активации данных методов необходимо обратиться в техподдержку.
Название метода: | wallet_history |
HTTP метод запроса: | POST |
Входящие параметры: | date - дата в формате Unix (timestamp) за которую нужно получить историю операций (если не указан берется текущий день) |
Пример использования на PHP: |
|
Возращаемый ответ: |
|
Описание полей: |
name - название API метода status - ok в случае успешного создания и error в случае ошибки id - содержит идентификатор ошибки msg - содержит текст ошибки begin - начало периода в формате Unix end - конец периода в формате Unix history - массив операций пользователя (история операций), где
|