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

Статус транзакций

Этот WebSocket поток предоставляет обновления о статусе созданных заявок, включая события создания, исполнения, частичного исполнения, отмены, замены и отклонения.


🔌 WebSocket URL

wss://ws.broker.ru/trade-api-bff-operations/api/v1/orders/transaction/ws

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

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

Authorization: Bearer <ACCESS_TOKEN>

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


📥 Формат успешного ответа

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

{
"originalClientOrderId": "517661df-d051-461d-9389-988abf24de4d",
"clientOrderId": "",
"data": {
"messageType": "8",
"orderStatus": "1",
"executionType": "12",
"orderQuantity": 100,
"executedQuantity": 50,
"lastQuantity": 50,
"remainedQuantity": 50,
"ticker": "SBER",
"classCode": "TQBR",
"side": "1",
"orderType": "2",
"averagePrice": 244.5,
"orderId": "20241030-TQBR-12345678910",
"executionId": "TQBR-Z3fE7c-S-1-1-N",
"price": 244.5,
"currency": "RUB",
"clientCode": "123456",
"transactionTime": "2024-10-30T09:01:00.000Z",
"tradeDate": "2024-10-30",
"orderNumber": "12345678910",
"accruedCoupon": 0,
"executionValue": 12225,
"commission": 12.3,
"securityExchange": "TQBR"
}
}

📄 Описание параметров

Поля ответа

ПолеТипОписание
originalClientOrderIdstring (uuid)Уникальный идентификатор измененной заявки
clientOrderIdstring (uuid)Уникальный идентификатор заявки
dataobject / nullКонтейнер данных статуса

Поля объекта data

ПолеТипОписание
messageTypestringТип сообщения
orderStatusstring (enum)Состояние заявки:
0 — Новая
1 — Частично исполнена
2 — Полностью исполнена
4 — Отменена
5 — Заменена
6 — Отменяется (в процессе отмены)
8 — Отклонена
9 — Заменяется (например, если вы изменяли заявку)
10 — Ожидает подтверждения новой заявки
executionTypestring (enum)Тип отчета. Возможные значения:
0 — Новая
1 — Частично исполнена
2 — Исполнена
4 — Отменена
6 — Ожидает отмены
5 — Заменена
8 — Отклонена
9 — Приостановлена
10 — Ожидает подтверждения новой
11 — Сделка
12 — Статус заявки
13 — Исправлено
orderQuantitynumberКоличество в заявке (шт.)
executedQuantitynumberИсполненное количество (шт.)
lastQuantitynumberКоличество в текущей сделке (шт.)
remainedQuantitynumberОставшееся количество (шт.)
tickerstringТикер инструмента
classCodestringКод класса ценной бумаги
sidestring (enum)1 – Покупка
2 – Продажа
orderTypestring (enum)1 – Рыночная заявка
2 – Лимитная заявка
averagePricenumberСредняя цена исполнения. Для сделок РЕПО/спредов: цена первой части
orderIdstringУникальный идентификатор заявки
executionIdstringУникальный идентификатор сделки
pricenumberЦена заявки
currencystringВалюта
clientCodestringКод клиента
transactionTimestring (datetime)Дата и время транзакции
tradeDatestring (datetime)Дата сделки:
Для вечерней сессии FORTS - дата следующей сессии
Обычные сделки - дата исполнения
orderNumberstringНомер заявки
accruedCouponnumberНакопленный купонный доход
executionValuenumberОбъем сделки
commissionnumberКомиссия
securityExchangestringИдентификатор биржи
rejectReasonstringПричина отклонения заявки

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

import WebSocket from "ws";

const URL = "wss://ws.broker.ru/trade-api-bff-operations/api/v1/orders/transaction/ws";

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

ws.on("open", () => {
console.log("connected");
});

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

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

❗ Ошибки

HTTPОшибкаОписание
401UNAUTHORIZEDОшибка авторизации
500INTERNAL SERVER ERRORВнутренняя ошибка сервера