xRocket Exchange REST API

API xRocket Exchange позволяет разработчикам интегрировать функции биржи xRocket в свои проекты, чтобы иметь возможность создавать, выполнять или отменять ордера, получать рыночные данные, отслеживать динамику цен торговых пар и т. д.

Базовый URL

Продакшенhttps://exchange.api.xrocket.exchange

Тестнетhttps://exchange.api.testnet.xrocket.exchange

Уведомление о прекращении поддержки API v1

Версия Trade API v1 (https://trade.xrocket.exchange/api) устарела, больше не поддерживается и скоро будет удалена. Пожалуйста перенесите свои интеграции на современную версию Exchange API.

Важные изменения в этой версии API

Кошелек xRocket имеет два типа баланса: Основной (Funding) и Торговый (Trading).

Эта версия API предназначена для обеспечения взаимодействия двух балансов.

внимание

Все публичные методы доступны без авторизации. Используйте REST API на данном сайте документации или наш Exchange API Swagger для тестирования и просмотра примеров запросов/ответов и других деталей.

Авторизация

Создайте аккаунт xRocket

Запустите @xRocket (для Mainnet) или @xrocket_testnet_bot (для Testnet) в Telegram — кошелёк/аккаунт xRocket будет автоматически создан и привязан к вашему Telegram-аккаунту.

Получите свой Bearer Token (API-ключ)

В @xRocket (для Mainnet) или @xrocket_testnet_bot (для Testnet) перейдите в Меню > Настройки > Настройки биржи > API токен.

Добавьте Bearer Token в запросы

Добавьте заголовок Authorization во все запросы к приватным методам API:

"Authorization: Bearer <YOUR_API_TOKEN>"

Защитите свой API-токен

Ваш Bearer Token (API-ключ) предоставляет полный доступ к вашему аккаунту, включая торговлю, переводы и вывод средств. Обращайтесь с ним так же, как с паролем от аккаунта — никогда не публикуйте его!

Сущности

xRocket Exchange API подразумевает взаимодействие следующих сущностей:

account // аккаунт пользователя xRocket
balance // баланс может быть основной или торговый и принадлежит аккаунту пользователя xRocket
symbol // торговая пара, например BTC-USDT
order // торговый ордер на покупку/продажу ассета на заданных пользователем условиях
trade // исполнения ордеров на бирже
ticker // рыночные данные торговой пары за указанный интервал времени
candle // агрегированные торговые данные для указанной пары и временного интервала
orderbook // общие суммы спроса/предложения торговой пары с указанной глубиной и точностью
transfer // перемещение актива внутри учетной записи, между основным и торговым балансом

Подробнее о сущностях

Пример запроса/ответа

В этом примере метод GET /api/v1/orders/history используется для запроса истории закрытых и отмененных торговых ордеров BTC-USDT за указанный интервал времени. Метод запрашивает данные, связанные с учетной записью xRocket. Для таких запросов требуется токен авторизации, который может быть выдан учетной записи пользователя.

curl -X 'GET' \
  'https://exchange.api.xrocket.exchange/api/v1/orders/history?symbol=BTC-USDT&side=buy&startAt=2024-12-24T14%3A49%3A13.543Z&endAt=2024-12-24T14%3A49%3A13.543Z&currentPage=1&pageSize=20&hideCanceled=false' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer 10Q9DG5BG0ReG3jCdyEQ6C5yQkhHRX'

Запрос отправляется на URL-адрес метода API: https://exchange.api.xrocket.exchange/api/v1/orders/history.

Пример поля запроса и значения	Описание
`symbol=BTC-USDT`	BTC-USDT задана как торговая пара (символ).
`side=buy`	Запрашиваются только ордера на покупку. В этом поле можно установить значение buy или sell. Не используйте это поле для получения всех ордеров (на покупку и продажу).
`startAt=2024-12-24T1:49:13.543Z`	В этом поле указывается начальная временная метка запрошенной истории.
`endAt=2024-12-24T14:49:13.543Z`	В этом поле указывается конечная временная метка запрошенной истории..
`currentPage=1`	В этом поле указывается страница, которая будет отображаться в ответе. Ответ может состоять из нескольких страниц.
`pageSize=20`	В этом поле указывается количество торговых записей на странице возвращаемого ответа.
`hideCanceled=false`	В этом поле указывается, включены ли в ответ отмененные заказы.
`'Authorization: Bearer 10Q9DG5BG0ReG3jCdyEQ6C5yQkhHRX'`	Метод GET /api/v1/orders/history запрашивает данные, связанные с учетной записью xRocket. Для таких запросов требуется токен авторизации, который может быть выдан учетной записи пользователя ботом xRocket.

Пример ответа:

{
  "orders": [

    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientOrderId": "string",
      "symbol": "BTC-USDT",
      "side": "buy",
      "status": "working",
      "createdAt": "2024-12-05T12:51:20.917Z",
      "updatedAt": "2024-12-05T12:51:20.917Z",
      "dealSize": "19.781",
      "dealFunds": "19.781",
      "fee": "1.82",
      "feeAsset": "USDT",
      "remark": "string",
      "timeInForce": "GTC",
      "type": "stopMarket",
      "size": "109.34",
      "stopTriggered": false,
      "stopPrice": "300.5"
    }
  ],
  "currentPage": 1,
  "pageSize": 20,
  "totalNum": 1,
  "totalPage": 1
}

Пример поля ответа и значения	Описание
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"	ID ордера.
"clientOrderId": "string"	Уникальный идентификатор, созданный клиентом.
"symbol": "BTC-USDT"	Торговая пара.
"side": "buy"	Ордер на покупку или продажу [ buy, sell ].
"status": "working"	Статус ордера [ working, rejected, cancelled, completed, expired, pending, sending ].
"createdAt": "2024-12-05T12:51:20.917Z"	Временная метка создания заказа.
"updatedAt": "2024-12-05T12:51:20.917Z"	Временная метка обновления ордера.
"dealSize": "19.781"	Исполненная сумма в базовом активе (BTC).
"dealFunds": "19.781"	Исполненный размер средств в котируемом активе (USDT).
"fee": "1.82"	Сумма комиссии.
"feeAsset": "USDT"	Актив для оплаты комиссии.
"timeInForce": "GTC"	Параметр "Time in force" [ GTC, IOC, FOK ]. GTC (Good 'Til Canceled), IOC (Immediate or Cancel), and FOK (Fill or Kill).
"type": "stopMarket"	Тип ордера [limit, market, stopLimit, stopMarket].
"size": "109.34"	Сумма ордера.
"stopTriggered": false	Указывает, сработал стоп-ордер или нет.
"stopPrice": "300.5"	Указывает стоп-цену.
"currentPage": 1	Текущая страница.
"pageSize": 20	Максимальное количество записей на странице.
"totalNum": 1	Общее количество возвращенных записей.
"totalPage": 1	Общее количество возвращенных страниц.

Методы

Найдите подходящую конечную точку для своего приложения в следующем списке всех доступных методов API xRocket Exchange с краткими описаниями, сгруппированными по категориям для упрощения навигации.

Метод	Описание
Рыночные данные	Методы для запроса публичных рыночных данных биржи.
Получить торговую пару	Запросить данные указанной торговой пары.
Получить торговые пары	Запросить список всех доступных торговых пар.
Получить тикер	Запросить рыночные данные торговой пары за указанный интервал времени.
Получить свечи	Запросить текущие данные свечей для указанной торговой пары.
Получить стакан заявок	Запросить текущие данные стакана заявок для указанной торговой пары.
Получить сделки	Запросить информацию о выполненных ордерах для указанной торговой пары.
Получить активы	Запросить список всех доступных активов.
Получить актив	Запросить информацию об указанном активе.
Курсы	Методы для запроса публичных курсов обмена.
Получить курсы	Запросить текущие курсы криптовалют в фиатной валюте.
Ордера	Методы для запроса деталей ордеров и управления ордерами.
Получить историю ордеров	Запросить историю ордеров. `Требуется авторизация`
Получить активные ордера	Запросить список активных ордеров. `Требуется авторизация`
Получить ордер	Запросить детали ордера по его ID. `Требуется авторизация`
Отменить ордер	Отменить торговый ордер по ID. `Требуется авторизация`
Разместить ордер	Разместить торговый ордер. `Требуется авторизация`
Оценить ордер	Запросить оценку ордера. `Требуется авторизация`
Аккаунт	Методы для запроса данных аккаунта.
Получить торговые балансы	Запросить текущие торговые балансы. `Требуется авторизация`
Получить торговые комиссии	Запросить текущие комиссии биржи для указанной торговой пары.
Фондирование	Методы для управления основными балансами и выводами средств.
Создать вывод	Создать запрос на вывод средств. `Требуется авторизация`
Получить основные балансы	Запросить текущие основные (funding) балансы. `Требуется авторизация`
Получить вывод по ID	Запросить детали вывода по идентификатору. `Требуется авторизация`
Получить историю выводов	Запросить историю выводов. `Требуется авторизация`
Получить лимиты вывода	Запросить лимиты на вывод средств.
Переводы	Методы для управления переводами между основным и торговым балансами.
Перевод	Перевести активы между основным и торговым балансами. `Требуется авторизация`
Получить историю переводов	Запросить историю переводов за указанный период. `Требуется авторизация`
Получить перевод по ID	Запросить детали перевода по идентификатору. `Требуется авторизация`

xRocket Exchange REST API

Базовый URL​

Авторизация​

Сущности​

Пример запроса/ответа​

Методы​

Базовый URL

Авторизация

Сущности

Пример запроса/ответа

Методы