Перейти к содержанию

Методы

OrdersStreamService

Методы сервиса

TradesStream

Stream сделок пользователя

OrdersService

Сервис предназначен для работы с торговыми поручениями:
1. выставление;
2. отмена;
3. получение статуса;
4. расчёт полной стоимости;
5. получение списка заявок.

Методы сервиса

PostOrder

Метод выставления заявки.

CancelOrder

Метод отмены биржевой заявки.

GetOrderState

Метод получения статуса торгового поручения.

GetOrders

Метод получения списка активных заявок по счёту.

ReplaceOrder

Метод изменения выставленной заявки.

Сообщения методов

TradesStreamRequest

Запрос установки соединения.

Field Type Description
accounts Массив объектов string Идентификаторы счетов.

TradesStreamResponse

Информация о торговых поручениях.

Field Type Description
order_trades OrderTrades Информация об исполнении торгового поручения.
ping Ping Проверка активности стрима.

OrderTrades

Информация об исполнении торгового поручения.

Field Type Description
order_id string Идентификатор торгового поручения.
created_at google.protobuf.Timestamp Дата и время создания сообщения в часовом поясе UTC.
direction OrderDirection Направление сделки.
figi string Figi-идентификатор инструмента.
trades Массив объектов OrderTrade Массив сделок.
account_id string Идентификатор счёта.
instrument_uid string UID идентификатор инструмента.

OrderTrade

Информация о сделке.

Field Type Description
date_time google.protobuf.Timestamp Дата и время совершения сделки в часовом поясе UTC.
price Quotation Цена за 1 инструмент, по которой совершена сделка.
quantity int64 Количество штук в сделке.
trade_id string Идентификатор сделки.

PostOrderRequest

Запрос выставления торгового поручения.

Field Type Description
figi string Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
quantity int64 Количество лотов.
price Quotation Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента. Игнорируется для рыночных поручений.
direction OrderDirection Направление операции.
account_id string Номер счёта.
order_type OrderType Тип заявки.
order_id string Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина 36 символов.
instrument_id string Идентификатор инструмента, принимает значения Figi или Instrument_uid.

PostOrderResponse

Информация о выставлении поручения.

Field Type Description
order_id string Биржевой идентификатор заявки.
execution_report_status OrderExecutionReportStatus Текущий статус заявки.
lots_requested int64 Запрошено лотов.
lots_executed int64 Исполнено лотов.
initial_order_price MoneyValue Начальная цена заявки. Произведение количества запрошенных лотов на цену.
executed_order_price MoneyValue Исполненная средняя цена одного инструмента в заявке.
total_order_amount MoneyValue Итоговая стоимость заявки, включающая все комиссии.
initial_commission MoneyValue Начальная комиссия. Комиссия рассчитанная при выставлении заявки.
executed_commission MoneyValue Фактическая комиссия по итогам исполнения заявки.
aci_value MoneyValue Значение НКД (накопленного купонного дохода) на дату. Подробнее: НКД при выставлении торговых поручений
figi string Figi-идентификатор инструмента.
direction OrderDirection Направление сделки.
initial_security_price MoneyValue Начальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
order_type OrderType Тип заявки.
message string Дополнительные данные об исполнении заявки.
initial_order_price_pt Quotation Начальная цена заявки в пунктах (для фьючерсов).
instrument_uid string UID идентификатор инструмента.

CancelOrderRequest

Запрос отмены торгового поручения.

Field Type Description
account_id string Номер счёта.
order_id string Идентификатор заявки.

CancelOrderResponse

Результат отмены торгового поручения.

Field Type Description
time google.protobuf.Timestamp Дата и время отмены заявки в часовом поясе UTC.

GetOrderStateRequest

Запрос получения статуса торгового поручения.

Field Type Description
account_id string Номер счёта.
order_id string Идентификатор заявки.

GetOrdersRequest

Запрос получения списка активных торговых поручений.

Field Type Description
account_id string Номер счёта.

GetOrdersResponse

Список активных торговых поручений.

Field Type Description
orders Массив объектов OrderState Массив активных заявок.

OrderState

Информация о торговом поручении.

Field Type Description
order_id string Биржевой идентификатор заявки.
execution_report_status OrderExecutionReportStatus Текущий статус заявки.
lots_requested int64 Запрошено лотов.
lots_executed int64 Исполнено лотов.
initial_order_price MoneyValue Начальная цена заявки. Произведение количества запрошенных лотов на цену.
executed_order_price MoneyValue Исполненная цена заявки. Произведение средней цены покупки на количество лотов.
total_order_amount MoneyValue Итоговая стоимость заявки, включающая все комиссии.
average_position_price MoneyValue Средняя цена позиции по сделке.
initial_commission MoneyValue Начальная комиссия. Комиссия, рассчитанная на момент подачи заявки.
executed_commission MoneyValue Фактическая комиссия по итогам исполнения заявки.
figi string Figi-идентификатор инструмента.
direction OrderDirection Направление заявки.
initial_security_price MoneyValue Начальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
stages Массив объектов OrderStage Стадии выполнения заявки.
service_commission MoneyValue Сервисная комиссия.
currency string Валюта заявки.
order_type OrderType Тип заявки.
order_date google.protobuf.Timestamp Дата и время выставления заявки в часовом поясе UTC.
instrument_uid string UID идентификатор инструмента.
order_request_id string Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов.

OrderStage

Сделки в рамках торгового поручения.

Field Type Description
price MoneyValue Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
quantity int64 Количество лотов.
trade_id string Идентификатор сделки.

ReplaceOrderRequest

Запрос изменения выставленной заявки.

Field Type Description
account_id string Номер счета.
order_id string Идентификатор заявки на бирже.
idempotency_key string Новый идентификатор запроса выставления поручения для целей идемпотентности. Максимальная длина 36 символов. Перезатирает старый ключ.
quantity int64 Количество лотов.
price Quotation Цена за 1 инструмент.
price_type PriceType Тип цены.

Enums

OrderDirection

Направление операции.

Name Number Description
ORDER_DIRECTION_UNSPECIFIED 0 Значение не указано
ORDER_DIRECTION_BUY 1 Покупка
ORDER_DIRECTION_SELL 2 Продажа

OrderType

Тип заявки.

Name Number Description
ORDER_TYPE_UNSPECIFIED 0 Значение не указано
ORDER_TYPE_LIMIT 1 Лимитная
ORDER_TYPE_MARKET 2 Рыночная
ORDER_TYPE_BESTPRICE 3 Лучшая цена

OrderExecutionReportStatus

Текущий статус заявки (поручения)

Name Number Description
EXECUTION_REPORT_STATUS_UNSPECIFIED 0 none
EXECUTION_REPORT_STATUS_FILL 1 Исполнена
EXECUTION_REPORT_STATUS_REJECTED 2 Отклонена
EXECUTION_REPORT_STATUS_CANCELLED 3 Отменена пользователем
EXECUTION_REPORT_STATUS_NEW 4 Новая
EXECUTION_REPORT_STATUS_PARTIALLYFILL 5 Частично исполнена

PriceType

Тип цены.

Name Number Description
PRICE_TYPE_UNSPECIFIED 0 Значение не определено.
PRICE_TYPE_POINT 1 Цена в пунктах (только для фьючерсов и облигаций).
PRICE_TYPE_CURRENCY 2 Цена в валюте расчётов по инструменту.

SecurityTradingStatus

Name Number Description
SECURITY_TRADING_STATUS_UNSPECIFIED 0 Торговый статус не определён
SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING 1 Недоступен для торгов
SECURITY_TRADING_STATUS_OPENING_PERIOD 2 Период открытия торгов
SECURITY_TRADING_STATUS_CLOSING_PERIOD 3 Период закрытия торгов
SECURITY_TRADING_STATUS_BREAK_IN_TRADING 4 Перерыв в торговле
SECURITY_TRADING_STATUS_NORMAL_TRADING 5 Нормальная торговля
SECURITY_TRADING_STATUS_CLOSING_AUCTION 6 Аукцион закрытия
SECURITY_TRADING_STATUS_DARK_POOL_AUCTION 7 Аукцион крупных пакетов
SECURITY_TRADING_STATUS_DISCRETE_AUCTION 8 Дискретный аукцион
SECURITY_TRADING_STATUS_OPENING_AUCTION_PERIOD 9 Аукцион открытия
SECURITY_TRADING_STATUS_TRADING_AT_CLOSING_AUCTION_PRICE 10 Период торгов по цене аукциона закрытия
SECURITY_TRADING_STATUS_SESSION_ASSIGNED 11 Сессия назначена
SECURITY_TRADING_STATUS_SESSION_CLOSE 12 Сессия закрыта
SECURITY_TRADING_STATUS_SESSION_OPEN 13 Сессия открыта
SECURITY_TRADING_STATUS_DEALER_NORMAL_TRADING 14 Доступна торговля в режиме внутренней ликвидности брокера
SECURITY_TRADING_STATUS_DEALER_BREAK_IN_TRADING 15 Перерыв торговли в режиме внутренней ликвидности брокера
SECURITY_TRADING_STATUS_DEALER_NOT_AVAILABLE_FOR_TRADING 16 Недоступна торговля в режиме внутренней ликвидности брокера

Нестандартные типы данных

MoneyValue

Денежная сумма в определенной валюте

Field Type Description
currency string Строковый ISO-код валюты
units int64 Целая часть суммы, может быть отрицательным числом
nano int32 Дробная часть суммы, может быть отрицательным числом

Quotation

Котировка - денежная сумма без указания валюты

Field Type Description
units int64 Целая часть суммы, может быть отрицательным числом
nano int32 Дробная часть суммы, может быть отрицательным числом