Биржевой стакан

GET 
/md/v2/orderbooks/:exchange/:symbol

Приватный ресурс

Запрос нельзя выполнить анонимно. Обязательный параметр token должен содержать актуальный Access токен.

WebSocket API

Для этой операции есть альтернатива в виде WebSocket-подписки.

Запрос возвращает информацию о текущем количестве лотов и их цене в бидах и асках биржевого стакана для указанного финансового инструмента.

Request

Path Parameters

exchange stringrequired
Possible values: [MOEX, SPBX]
Биржа:
• MOEX — Московская биржа
• SPBX — СПБ Биржа
symbol stringrequired
Тикер (Код финансового инструмента)
Example: SBER

Query Parameters

depth int32
Possible values: >= 1 and <= 50
Default value: 20
Глубина стакана. Стандартное значение — 20 (20х20), максимальное — 50 (50х50)
Example: 5
format string
Possible values: [Simple, Slim, Heavy]
Формат возвращаемого сервером JSON-объекта:
• Simple — оригинальный формат данных. Поддерживает устаревшие параметры для обеспечения обратной совместимости
• Slim — облегчённый формат данных для быстрой передачи сообщений. Не поддерживает устаревшие параметры
• Heavy — полный формат данных, развивающийся и дополняющийся новыми полями. Не поддерживает устаревшие параметры
От формата объекта также зависит минимальное значение параметра frequency для WebSocket-подписок.
Example: Simple

Responses

200

Запрос успешно обработан

application/json

Schema

Schema

oneOf

response_OrderBook_Simple

Данные о "биржевом стакане" в формате Simple

snapshot flag_Snapshot_Deprecated (boolean)deprecated

Deprecated. Устаревшее поле, будет удалено в будущих обновлениях

bids

object[]

Список бидов в биржевом стакане

Array [

price decimal

Цена

volume int32

Объём

]

asks

object[]

Список асков в биржевом стакане

Array [

price decimal

Цена

volume int32

Объём

]

timestamp decimaldeprecated

Deprecated. Устаревшее поле, будет удалено в будущих обновлениях. Вместо этого поля используйте поле ms_timestamp

ms_timestamp int64

Время (UTC) в формате Unix Time Milliseconds

existing flag_Snapshot (boolean)

True — для данных из "снепшота", то есть из истории. False — для новых событий

response_OrderBook_Slim

Данные о "биржевом стакане" в формате Slim

b

object[]

Список бидов в биржевом стакане

Array [

p decimal

Цена

v int32

Объём

y decimalnullable

Только для облигаций. Доходность облигации

]

a

object[]

Список асков в биржевом стакане

Array [

p decimal

Цена

v int32

Объём

y decimalnullable

Только для облигаций. Доходность облигации

]

t int64

Время (UTC) в формате Unix Time Milliseconds

h flag_Snapshot (boolean)

True — для данных из "снепшота", то есть из истории. False — для новых событий

response_OrderBook_Heavy

Данные о "биржевом стакане" в формате Heavy

bids

object[]

Список бидов в биржевом стакане

Array [

price decimal

Цена

volume int32

Объём

]

asks

object[]

Список асков в биржевом стакане

Array [

price decimal

Цена

volume int32

Объём

]

msTimestamp int64

Время (UTC) в формате Unix Time Milliseconds

existing flag_Snapshot (boolean)

True — для данных из "снепшота", то есть из истории. False — для новых событий

Example (from schema)

{}

Пример Simple

Пример ответа в формате Simple

{
  "snapshot": true,
  "bids": [
    {
      "price": 281.98,
      "volume": 36
    }
  ],
  "asks": [
    {
      "price": 281.99,
      "volume": 11
    }
  ],
  "timestamp": 1701105939,
  "ms_timestamp": 1701105939395,
  "existing": true
}

Пример Slim (Общий)

Пример ответа в формате Slim (Общий)

{
  "b": [
    {
      "p": 281.98,
      "v": 36
    }
  ],
  "a": [
    {
      "p": 281.99,
      "v": 11
    }
  ],
  "t": 1701105939395,
  "h": true
}

Пример Slim (Облигации)

Пример ответа в формате Slim (Облигации)

{
  "b": [
    {
      "p": 70.589,
      "v": 146,
      "y": 16.21
    }
  ],
  "a": [
    {
      "p": 70.772,
      "v": 10,
      "y": 16.14
    }
  ],
  "t": 1721372266417,
  "h": false
}

Пример Heavy

Пример ответа в формате Heavy

{
  "bids": [
    {
      "price": 281.98,
      "volume": 36
    }
  ],
  "asks": [
    {
      "price": 281.99,
      "volume": 11
    }
  ],
  "msTimestamp": 1701105939395,
  "existing": true
}

401

Не удалось авторизовать запрос — JWT не указан в заголовке запроса, срок его действия истёк или он относится к другому контуру системы

Loading...