Перейти к основному содержимому

Книга ордеров

Обновления книги ордеров в режиме реального времени.

внимание

Первый ответ после подписки содержит полный снимок книги ордеров. Последующие сообщения являются инкрементальными обновлениями — проверяйте поле snapshot, чтобы различать их.

Запрос на подписку:

{
  "id": "12345",
  "method": "subscribe",
  "params": {
    "channel": "orderbook",
    "symbol": "BTC-USDT",
    "depth": 20,
    "precision": "0.01"
  }
}

Параметры запроса​

ПараметрОписание
symbol (обязательный)Символ торговой пары. Укажите торговую пару, чтобы получать обновления. См. все доступные на данный момент торговые пары в статье Get /api/v1/symbols.
depth (необязательный)Количество ценовых уровней. Доступные значения: 5, 10, 20, 50, 100, 200, 500.
precision (необязательный)Точность цены. Пример доступных значений: 0.0001, 0.001, 0.01, 0.1, 1. См. GET /api/v1/symbols/symbol, чтобы получить значения точности для других пар.

Ответ​

Первый ответ на подписку содержит полный снимок книги ордеров.

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

{
  "id": "12345",
  "result": {
    "success": true,
    "sequence": "3262786978",
    // значения "51190.00" и "0.45054140" представляют [цена: string, размер: string]
    "bids": [["51190.00", "0.45054140"],["51185.00", "1.20000000"]],
    "asks": [["51200.00", "0.30000000"],["51205.00", "0.75000000"]],
    "askTotalAmount": "1239.22351",
    "bidTotalAmount": "1156.45678"
  }
}

В этом примере: значения в парах «51190.00» и «0.45054140» подразумевают [цена: string, размер: string], что означает, что первое значение — это цена, а второе — сумма.

Пример потока данных:

{
  "method": "subscription",
  "params": {
    "channel": "orderbook",
    "symbol": "BTC-USDT",
    "depth": 20,
    "precision": "0.01",
    "data": {
      "snapshot": true,
      "sequence": "3262786979",
      "bids": [["51190.00", "0.45054140"],["51185.00", "1.20000000"]],
      "asks": [["51200.00", "0.30000000"],["51205.00", "0.75000000"]],
      "askTotalAmount": "1239.22351",
      "bidTotalAmount": "1156.45678"
    }
  }
}

Параметры ответа​

ПараметрОписание
symbol (обязательный)Торговая пара.
depth (необязательный)Количество ценовых уровней, параметр задается в запросе.
precision (необязательный)Точность цены, параметр задается в запросе.
snapshot (обязательный)true — возвращается полный снимок книги ордеров, false — только инкрементальные обновления.
sequence (обязательный)Порядковый номер обновления книги ордеров. Тип: string.
bids (обязательный)Массив ценовых уровней на покупку (bid), отсортированных по цене по убыванию (лучшая цена первой). Каждая запись: [цена, размер]. Тип: array.
asks (обязательный)Массив ценовых уровней на продажу (ask), отсортированных по цене по возрастанию (лучшая цена первой). Каждая запись: [цена, размер]. Тип: array.
askTotalAmount (обязательный)Общая сумма или объем всех текущих ордеров на продажу (sell). Тип: string.
bidTotalAmount (обязательный)Общая сумма или объем всех текущих ордеров на покупку (buy). Тип: string.