Описание сущностей
xRocket Exchange API обеспечивает программное взаимодействие с нашей торговой платформой, предоставляя доступ к набору основных объектов. Важно понимать эти сущности и то, как они связаны. В этой статье описаны ключевые сущности xRocket Exchange API.
Аккаунт (Account)
Аккаунт представляет собой кошелек отдельного пользователя xRocket и его финансовое положение на бирже. Это сущность верхнего уровня, которая содержит все остальные данные, связанные с пользователем, включая балансы по различным активам.
Взаимодействие с API: Сущность аккаунт, как правило, доступна через приватные конечные точки API, которые требуют наличия Bearer Token для авторизации. Эти методы позволяют получать данные аккаунта, его настройки и разрешения.
Баланс (Balance)
Баланс является подсущностью аккаунта и отслеживает количество определенного актива, принадлежащего пользователю. В xRocket общий баланс пользователя по каждому активу может быть разделен на два типа:
- Основной баланс (Funding Balance): Это баланс, хранящийся в основном кошельке пользователя. Он используется для пополнений, выводов средств и внутренних переводов между пользователями.
- Торговый баланс (Trading Balance): Это баланс, выделенный для использования в торговом движке биржи. Он может быть использован для размещения ордеров.
Взаимодействие с API: Данные по балансу можно получить через приватные конечные точки кошелька, что позволяет проверить текущие доступные и заблокированные суммы по каждому активу.
Вам необходимо перевести средства с основного баланса на торговый баланс, прежде чем вы сможете размещать ордера. Это отдельные балансы, и средства на одном из них не доступны автоматически на другом.
Символ (Symbol)
Символ представляет собой отдельную торговую пару на бирже xRocket, например, BTC-USDT или TON-USDT. Это фундаментальный идентификатор для всех торговых операций и рыночных данных.
Взаимодействие с API: Символ — это ключевой параметр, используемый практически во всех конечных точках рыночных данных и торговли для указания того, к какой паре активов относится запрос или данные.
Ордер (Order)
Ордер — это инструкция, размещенная пользователем, на покупку или продажу определенного количества актива на заданных пользователем условиях. Жизненный цикл ордера включает создание, возможное сопоставление (исполнение), и в конечном итоге завершение или отмену.
Взаимодействие с API: Ордера управляются через приватные торговые методы. Вы можете создавать новые ордера (рыночные, лимитные), отменять существующие и получать историю своих ордеров.
Сделка (Trade)
Сделка представляет собой исполненный ордер или часть ордера, которая была успешно выполнена на бирже. Когда ордер исполняется, генерируется одна или несколько сделок.
Взаимодействие с API: Сущность сделка доступна через приватные торговые конечные точки для получения истории ваших прошлых исполненных сделок, которая включает такие детали, как цена, количество и временная метка.
Сущности рыночных данных (Symbol, Ticker, Candle, Orderbook) доступны через публичные методы, не требующие аутентификации. Сущности Account, Balance, Order и Transfer требуют Bearer Token.
Тикер (Ticker)
Тикер содержит высокоуровневые рыночные данные в реальном времени для указанного символа за определенный интервал времени. Он дает краткий обзор текущего состояния торговой пары.
Взаимодействие с API: Данные тикера можно получить через публичный API-метод, который предоставляет информацию о последней цене сделки, 24-часовом максимуме, 24-часовом минимуме и 24-часовом объеме.
Свеча (Candle)
Свеча (candle, candlestick) представляет собой агрегированные торговые данные для указанного символа за определенный временной интервал (например, 1 час, 1 день). Свеча объединяет цены открытия, закрытия, максимума и минимума, а также объем за этот период.
Взаимодействие с API: Данные свечей доступны через публичную конечную точку API, что важно для технического анализа и бэктестинга (тестирования на исторических данных).
Книга ордеров (Orderbook)
Книга ордеров — это список всех активных ордеров для определенного символа, отсортированных по цене. Она состоит из двух сторон:
- Заявки на покупку (Bids): Ордера от покупателей на покупку актива, отсортированные от наивысшей к наименьшей цене.
- Заявки на продажу (Asks): Ордера от продавцов на продажу актива, отсортированные от наименьшей к наивысшей цене.
Взаимодействие с API: Книгу ордеров можно получить через публичный метод. Вы можете указать желаемую глубину и точность данных.
Перевод (Transfer)
Перевод представляет собой перемещение актива между внутренними балансами пользователя, в частности, с основного баланса на торговый баланс или наоборот.
Взаимодействие с API: Переводы управляются через приватные методы кошелька. Эта функциональность критически важна для разработчиков, создающих приложения, которым необходимо перемещать средства на активный торговый баланс и обратно.