Стакан

WebSocket API позволяет получать стакан котировок (Order Book) в реальном времени с глубиной до 20 уровней.

---

🔌 WebSocket URL

wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws

🔐 Аутентификация

Перед установкой WebSocket-соединения клиент должен передать access-token в HTTP-заголовке:

Authorization: Bearer <ACCESS_TOKEN>

Подробнее об авторизации см. раздел Авторизация.

---

🧱 Общий формат сообщений

Все сообщения в WebSocket передаются в формате JSON.

• Клиент → сервер: команды подписки / отписки.
• Сервер → клиент: подтверждения подписки, данные стаканов, ошибки.

---

📤 Сообщения client → server

Подписка на стакан

{
  "subscribeType": 0,
  "dataType": 0,
  "depth": 20,
  "instruments": [
    {
      "ticker": "SBER",
      "classCode": "TQBR"
    }
  ]
}

Поля запроса

Поле	Где	Тип	Обяз.	Описание
subscribeType	Тело	number (enum)	да	Тип сообщения: 0 — Подписка 1 — Отписка
dataType	Тело	number	да	Тип данных: 0 — Стакан
depth	Тело	number	нет	Глубина стакана (1–20). По умолчанию: 20
instruments	Тело	array	да	Список инструментов
instruments[].ticker	Тело	string	да	Биржевой тикер
instruments[].classCode	Тело	string	да	Код класса бумаги

Отписка

{
  "subscribeType": 1,
  "dataType": 0,
  "instruments": [
    { "ticker": "SBER", "classCode": "TQBR" }
  ]
}

---

📥 Сообщения server → client

Успешный ответ о подписке

{
  "responseType": "OrderBookSuccess",
  "subscribeType": 0,
  "ticker": "SBER",
  "classCode": "TQBR",
  "depth": 20,
  "dateTime": "2024-10-30T09:01:00.000Z"
}

Структура данных успешной подписки

Поле	Тип	Описание
responseType	string (enum)	OrderBookSuccess – успешная подписка на стакан
subscribeType	number (enum)	Тип сообщения: 0 — Подписка 1 — Отписка
ticker	string	Тикер
classCode	string	Класс
depth	number	Глубина стакана
dateTime	string (datetime)	Дата и время обновления стакана

Успешный ответ

{
  "responseType": "OrderBook",
  "ticker": "SBER",
  "classCode": "TQBR",
  "depth": 20,
  "dateTime": "2024-10-30T09:01:00.000Z",
  "bidVolume": "59851",
  "askVolume": "90339",
  "bids": [
    { "price": 244.30, "quantity": 100 },
    { "price": 244.25, "quantity": 90 }
  ],
  "asks": [
    { "price": 244.35, "quantity": 120 },
    { "price": 244.40, "quantity": 50 }
  ]
}

---

Структура данных ответа с данными

Поле	Тип	Описание
responseType	string (enum)	OrderBook – данные стакана
ticker	string	Тикер
classCode	string	Класс
depth	number	Глубина стакана
bidVolume	number	Объем покупателей в шт.
askVolume	number	Объем продавцов в шт.
bids	array	Предложения покупки
bids[].price	number	Цена
bids[].quantity	number	Количество
asks	array	Предложения продажи
asks[].price	number	Цена
asks[].quantity	number	Количество
dateTime	string (datetime)	Дата и время обновления стакана

---

Пример ответа с ошибкой

{
  "responseType": "OrderBook",
  "errors": [
    {
      "message": "Input JSON structure does not match structure, 'instruments' field is undefined.",
      "code": "INCORRECT_JSON"
    }
  ]
}

Структура данных ошибки

Поле	Тип	Описание
responseType	string (enum)	Тип сообщения. Для ошибок по сделкам — OrderBook
errors[].message	string	Текст ошибки
errors[].code	string (enum)	Код ошибки: NO_DATE — нет данных NOT_FOUND — инструмент не найден INCORRECT_JSON – невалидный json BAD_REQUEST — ошибка выполнения UNAUTHORIZED — клиент не авторизован

---

💻 Примеры использования

JavaScript (Node.js)

import WebSocket from "ws";

const URL = "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws";

const ws = new WebSocket(URL, {
  headers: {
    Authorization: "Bearer YOUR_ACCESS_TOKEN",
  },
});

ws.on("open", () => {
  const subscribeMessage = {
    subscribeType: 0,
    dataType: 0,
    depth: 20,
    instruments: [{ ticker: "SBER", classCode: "TQBR" }],
  };

  ws.send(JSON.stringify(subscribeMessage));
});

ws.on("message", (event) => {
  const payload = JSON.parse(event.toString());
  console.log(payload);
});

ws.on("error", (error) => {
  console.error("WebSocket error:", error);
});

Python

import asyncio
import json
import websockets

URL = "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws"
TOKEN = "YOUR_ACCESS_TOKEN"

async def main():
    async with websockets.connect(
        URL,
        additional_headers={"Authorization": f"Bearer {TOKEN}"},
    ) as ws:
        subscribe_message = {
            "subscribeType": 0,
            "dataType": 0,
            "depth": 20,
            "instruments": [{"ticker": "SBER", "classCode": "TQBR"}],
        }
        await ws.send(json.dumps(subscribe_message))

        async for message in ws:
            data = json.loads(message)
            print(data)

if __name__ == "__main__":
    asyncio.run(main())

Go (Golang)

package main

import (
    "log"
    "net/http"

    "github.com/gorilla/websocket"
)

func main() {
    header := http.Header{}
    header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN")

    c, _, err := websocket.DefaultDialer.Dial(
        "wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws",
        header,
    )
    if err != nil {
        log.Fatal("dial:", err)
    }
    defer c.Close()

    subscribeMessage := map[string]interface{}{
        "subscribeType": 0,
        "dataType":       0,
        "depth":          20,
        "instruments": []map[string]string{
            {"ticker": "SBER", "classCode": "TQBR"},
        },
    }

    if err := c.WriteJSON(subscribeMessage); err != nil {
        log.Fatal("write:", err)
    }

    for {
        var payload map[string]interface{}
        if err := c.ReadJSON(&payload); err != nil {
            log.Println("read:", err)
            return
        }
        log.Printf("received: %#v", payload)
    }
}

Java

import okhttp3.*;

public class OrderBookWs {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws")
            .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .build();

        WebSocketListener listener = new WebSocketListener() {
            @Override
            public void onOpen(WebSocket webSocket, Response response) {
                String subscribeMessage = """
                    {
                      "subscribeType": 0,
                      "dataType": 0,
                      "depth": 20,
                      "instruments": [
                        { "ticker": "SBER", "classCode": "TQBR" }
                      ]
                    }
                    """;
                webSocket.send(subscribeMessage);
            }

            @Override
            public void onMessage(WebSocket webSocket, String text) {
                System.out.println(text);
            }

            @Override
            public void onFailure(WebSocket webSocket, Throwable t, Response response) {
                t.printStackTrace();
            }
        };

        client.newWebSocket(request, listener);
    }
}

C#

using System;
using System.Net.WebSockets;
using System.Text;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var ws = new ClientWebSocket();
        ws.Options.SetRequestHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN");

        await ws.ConnectAsync(
            new Uri("wss://ws.broker.ru/trade-api-market-data-connector/api/v1/market-data/ws"),
            CancellationToken.None
        );

        var subscribeMessage = new
        {
            subscribeType = 0,
            dataType = 0,
            depth = 20,
            instruments = new[]
            {
                new { ticker = "SBER", classCode = "TQBR" }
            }
        };

        string payload = JsonSerializer.Serialize(subscribeMessage);
        await ws.SendAsync(
            Encoding.UTF8.GetBytes(payload),
            WebSocketMessageType.Text,
            endOfMessage: true,
            cancellationToken: CancellationToken.None
        );

        var buffer = new byte[8192];

        while (ws.State == WebSocketState.Open)
        {
            var result = await ws.ReceiveAsync(buffer, CancellationToken.None);
            if (result.MessageType == WebSocketMessageType.Close)
            {
                break;
            }

            var json = Encoding.UTF8.GetString(buffer, 0, result.Count);
            Console.WriteLine(json);
        }
    }
}

---

❗ Ошибки

HTTP	Текст	Описание
400	BadRequest	Неверные параметры
500	Internal Server Error	Внутренняя ошибка сервера