Описание API криптовалютной биржи BuyOwnEx

Общая информация

Параметры метода ожидаются в формате GET или POST (в зависимости от типа метода). Все ответы от сервера приходят в формате JSON.

При успешном выполнении приходит ответ типа:

{"success":true,{<ответ>}}

Ответ при ошибке:

{"success":false,"code":<код ошибки>,"errors":[<массив ошибок>]}
  • errors – представляет из себя описание ошибок при поступлении запроса с не валидными входными параметрами
  • code – представляет из себя целочисленный код ошибки. Все коды возможных ошибок и их описание представлено ниже

Авторизация

Часть API запросов является общедоступной без авторизации, однако большая часть требует указать API ключ. API ключ передается в http заголовке X-Api-Key в формате X-Api-Key: Bearer <API Key>
Для получения API ключа, необходимо выполнить POST следующий запрос:

Адрес и тип запроса:

POST запрос по адресу https://demo.buyownex.com/api/login

Заголовки:

Content-Type: application/x-www-form-urlencoded

Обязательные параметры:

  • email – email, указанный вами при регистрации
  • password – ваш текущий пароль

Пример:

email=user@example.com&password=qwerty

При удачном ответе вернется строка в JSON формате

{"success":true,"token":"<token>"}

где
token – API ключ, который необходимо в некоторых API запросах передавать в заголовке X-Api-Key

Ограничения

При работе с API действуют следующие ограничения:
Разрешается не более 60 запросов в минуту. В каждом ответе на ваш запрос возвращаются два заголовка X-RateLimit-Limit и X-RateLimit-Remaining

  • X-RateLimit-Limit – разрешенное кол-во запросов в минуту
  • X-RateLimit-Remaining – оставшееся кол-во разрешенных запросов в данную минуту

Коды возврата и коды ошибок API

Возможные коды возврата:

Код возврата Описание
200 Успешный код возврата
422 Не пройдена валидация входящих параметров
401 Не успешная авторизация по адресу /api/login
500 Неизвестная системная ошибка
400 Ошибка при запросе к API. В данном случае обязательно возвращается еще и код ошибки, поясняющий причину ошибки. Все возможные коды ошибок см. ниже

Возможные коды ошибок:

Код ошибки Описание
9 Недостаточно денежных средств
10 Ошибка при валидации входных параметров
13 Указана отрицательная или нулевая сумма
14 Неизвестная системная ошибка при получении тикера
15 Не найдена валютная пара
16 Задана слишком большая сумма
17 Количество покупаемой/продаваемой валюты при выставлении ордера меньше допустимой
18 Указана отрицательная или нулевая цена при выставлении ордера
19 Указана слишком большая цена при выставлении ордера
20 Неизвестная системная ошибка при выставлении ордера
21 Неизвестная системная ошибка при отмене ордера

Публичное API

Получение тикера

GET запрос по адресу https://demo.buyownex.com/api/exchange/ticker?pair=<pair?>

Если указан параметр pair, то возвращаются данные только по заданной валютной паре, если не указан параметр pair, то возвращаются данные по всем валютным парам

Заголовки:
отсутствуют

Необязательные параметры:
pair (валютная пара в формате <код_валюты_торгов>_<код_валюты_рынка>)

Пример:

https://demo.buyownex.com/api/exchange/ticker?pair=USDT_BTC

При удачном ответе вернется строка в JSON формате

                    {
                        "success":true,
                        "ticker":
                        {
                            "currency":"USDT",
                            "market":"BTC",
                            "best_bid":0.000186,
                            "best_ask":0.000188,
                            "close":0.000169,
                            "last":0.000187
                        }
                    }
                

где

  • best_bid – цена наилучшего ордера на покупку USDT за BTC
  • best_ask – цена наилучшего ордера на продажу USDT за BTC
  • close – цена закрытия за предыдущий день
  • last – последняя цена сделки

Получить информацию о последних сделках по заданной паре валют

GET запрос по адресу https://demo.buyownex.com/api/exchange/public_trades?pair=<pair>&limit=<limit>&type=<type>

Заголовки:
отсутствуют

Обязательные параметры:
pair (валютная пара в формате <код_валюты_торгов>_<код_валюты_рынка>)

Необязательные параметры:
limit (количество последних сделок), если не указано, то возвращается 30 последних сделок. Максимальное значение устанавливается в параметрах системы.
type (направленность сделки). 0 – сделки по покупке, 1 – сделки по продаже

Пример:

https://demo.buyownex.com/api/exchange/public_trades?pair=USDT_BTC&limit=2

При удачном ответе вернется строка в JSON формате

                    {
                        "success":true,
                        "count":2,
                        "trades":[
                            {
                                "currency":"USDT",
                                "market":"BTC",
                                "deal_id":12345,
                                "price":0.000188,
                                "amount":1.01,
                                "type":"BUY",
                                "time":1409935047
                            },
                            {
                                "currency":"USDT",
                                "market":"BTC",
                                "deal_id":12346,
                                "price":0.000187,
                                "amount":1.21,
                                "type":"SELL",
                                "time":1409935047
                            }
                        ]
                    }
                

где

  • count – цена наилучшего ордера на покупку USDT за BTC
  • deal_id – цена наилучшего ордера на продажу USDT за BTC
  • price – цена закрытия за предыдущий день
  • amount – последняя цена сделки
  • type – направленность сделки: BUY – сделка по покупке, SELL – сделка по продаже
  • time – время заключения сделки в формате UNIX timestamp