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

Методы

MarketDataService

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

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

GetCandles

Метод запроса исторических свечей по инструменту.

GetLastPrices

Метод запроса последних цен по инструментам.

GetOrderBook

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

GetTradingStatus

Метод запроса статуса торгов по инструментам.

GetLastTrades

Метод запроса последних обезличенных сделок по инструменту на текущий торговый день с максимальным интервалом в 1 час.

MarketDataStreamService

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

MarketDataStream

Bi-directional стрим предоставления биржевой информации.

MarketDataServerSideStream

Server-side стрим предоставления биржевой информации.

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

MarketDataRequest

Запрос подписки или отписки на определённые биржевые данные.

Field Type Description
subscribe_candles_request SubscribeCandlesRequest Запрос подписки на свечи.
subscribe_order_book_request SubscribeOrderBookRequest Запрос подписки на стаканы.
subscribe_trades_request SubscribeTradesRequest Запрос подписки на ленту обезличенных сделок.
subscribe_info_request SubscribeInfoRequest Запрос подписки на торговые статусы инструментов.
subscribe_last_price_request SubscribeLastPriceRequest Запрос подписки на последние цены.

MarketDataServerSideStreamRequest

Field Type Description
subscribe_candles_request SubscribeCandlesRequest Запрос подписки на свечи.
subscribe_order_book_request SubscribeOrderBookRequest Запрос подписки на стаканы.
subscribe_trades_request SubscribeTradesRequest Запрос подписки на ленту обезличенных сделок.
subscribe_info_request SubscribeInfoRequest Запрос подписки на торговые статусы инструментов.
subscribe_last_price_request SubscribeLastPriceRequest Запрос подписки на последние цены.

MarketDataResponse

Пакет биржевой информации по подписке.

Field Type Description
subscribe_candles_response SubscribeCandlesResponse Результат подписки на свечи.
subscribe_order_book_response SubscribeOrderBookResponse Результат подписки на стаканы.
subscribe_trades_response SubscribeTradesResponse Результат подписки на поток обезличенных сделок.
subscribe_info_response SubscribeInfoResponse Результат подписки на торговые статусы инструментов.
candle Candle Свеча.
trade Trade Сделки.
orderbook OrderBook Стакан.
trading_status TradingStatus Торговый статус.
ping Ping Проверка активности стрима.
subscribe_last_price_response SubscribeLastPriceResponse Результат подписки на последние цены инструментов.
last_price LastPrice Последняя цена.

SubscribeCandlesRequest

subscribeCandles | Изменения статуса подписки на свечи.

Field Type Description
subscription_action SubscriptionAction Изменение статуса подписки.
instruments Массив объектов CandleInstrument Массив инструментов для подписки на свечи.
waiting_close bool Флаг ожидания закрытия временного интервала для отправки свечи.

CandleInstrument

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

Field Type Description
figi string Figi-идентификатор инструмента.
interval SubscriptionInterval Интервал свечей.

SubscribeCandlesResponse

Результат изменения статус подписки на свечи.

Field Type Description
tracking_id string Уникальный идентификатор запроса, подробнее: tracking_id.
candles_subscriptions Массив объектов CandleSubscription Массив статусов подписки на свечи.

CandleSubscription

Статус подписки на свечи.

Field Type Description
figi string Figi-идентификатор инструмента.
interval SubscriptionInterval Интервал свечей.
subscription_status SubscriptionStatus Статус подписки.

SubscribeOrderBookRequest

Запрос на изменение статуса подписки на стаканы.

Field Type Description
subscription_action SubscriptionAction Изменение статуса подписки.
instruments Массив объектов OrderBookInstrument Массив инструментов для подписки на стаканы.

OrderBookInstrument

Запрос подписки на стаканы.

Field Type Description
figi string Figi-идентификатор инструмента.
depth int32 Глубина стакана.

SubscribeOrderBookResponse

Результат изменения статуса подписки на стаканы.

Field Type Description
tracking_id string Уникальный идентификатор запроса, подробнее: tracking_id.
order_book_subscriptions Массив объектов OrderBookSubscription Массив статусов подписки на стаканы.

OrderBookSubscription

Статус подписки.

Field Type Description
figi string Figi-идентификатор инструмента.
depth int32 Глубина стакана.
subscription_status SubscriptionStatus Статус подписки.

SubscribeTradesRequest

Изменение статуса подписки на поток обезличенных сделок.

Field Type Description
subscription_action SubscriptionAction Изменение статуса подписки.
instruments Массив объектов TradeInstrument Массив инструментов для подписки на поток обезличенных сделок.

TradeInstrument

Запрос подписки на поток обезличенных сделок.

Field Type Description
figi string Figi-идентификатор инструмента.

SubscribeTradesResponse

Результат изменения статуса подписки на поток обезличенных сделок.

Field Type Description
tracking_id string Уникальный идентификатор запроса, подробнее: tracking_id.
trade_subscriptions Массив объектов TradeSubscription Массив статусов подписки на поток сделок.

TradeSubscription

Статус подписки.

Field Type Description
figi string Figi-идентификатор инструмента.
subscription_status SubscriptionStatus Статус подписки.

SubscribeInfoRequest

Изменение статуса подписки на торговый статус инструмента.

Field Type Description
subscription_action SubscriptionAction Изменение статуса подписки.
instruments Массив объектов InfoInstrument Массив инструментов для подписки на торговый статус.

InfoInstrument

Запрос подписки на торговый статус.

Field Type Description
figi string Figi-идентификатор инструмента.

SubscribeInfoResponse

Результат изменения статуса подписки на торговый статус.

Field Type Description
tracking_id string Уникальный идентификатор запроса, подробнее: tracking_id.
info_subscriptions Массив объектов InfoSubscription Массив статусов подписки на торговый статус.

InfoSubscription

Статус подписки.

Field Type Description
figi string Figi-идентификатор инструмента.
subscription_status SubscriptionStatus Статус подписки.

SubscribeLastPriceRequest

Изменение статуса подписки на последнюю цену инструмента.

Field Type Description
subscription_action SubscriptionAction Изменение статуса подписки.
instruments Массив объектов LastPriceInstrument Массив инструментов для подписки на последнюю цену.

LastPriceInstrument

Запрос подписки на последнюю цену.

Field Type Description
figi string Figi-идентификатор инструмента.

SubscribeLastPriceResponse

Результат изменения статуса подписки на последнюю цену.

Field Type Description
tracking_id string Уникальный идентификатор запроса, подробнее: tracking_id.
last_price_subscriptions Массив объектов LastPriceSubscription Массив статусов подписки на последнюю цену.

LastPriceSubscription

Статус подписки на последнюю цену.

Field Type Description
figi string Figi-идентификатор инструмента.
subscription_status SubscriptionStatus Статус подписки.

Candle

Пакет свечей в рамках стрима.

Field Type Description
figi string Figi-идентификатор инструмента.
interval SubscriptionInterval Интервал свечи.
open Quotation Цена открытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
high Quotation Максимальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
low Quotation Минимальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
close Quotation Цена закрытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
volume int64 Объём сделок в лотах.
time google.protobuf.Timestamp Время начала интервала свечи в часовом поясе UTC.
last_trade_ts google.protobuf.Timestamp Время последней сделки, вошедшей в свечу в часовом поясе UTC.

OrderBook

Пакет стаканов в рамках стрима.

Field Type Description
figi string Figi-идентификатор инструмента.
depth int32 Глубина стакана.
is_consistent bool Флаг консистентности стакана. false значит не все заявки попали в стакан по причинам сетевых задержек или нарушения порядка доставки.
bids Массив объектов Order Массив предложений.
asks Массив объектов Order Массив спроса.
time google.protobuf.Timestamp Время формирования стакана в часовом поясе UTC по времени биржи.
limit_up Quotation Верхний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
limit_down Quotation Нижний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.

Order

Массив предложений/спроса.

Field Type Description
price Quotation Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
quantity int64 Количество в лотах.

Trade

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

Field Type Description
figi string Figi-идентификатор инструмента.
direction TradeDirection Направление сделки.
price Quotation Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
quantity int64 Количество лотов.
time google.protobuf.Timestamp Время сделки в часовом поясе UTC по времени биржи.

TradingStatus

Пакет изменения торгового статуса.

Field Type Description
figi string Figi-идентификатор инструмента.
trading_status SecurityTradingStatus Статус торговли инструментом.
time google.protobuf.Timestamp Время изменения торгового статуса в часовом поясе UTC.
limit_order_available_flag bool Признак доступности выставления лимитной заявки по инструменту.
market_order_available_flag bool Признак доступности выставления рыночной заявки по инструменту.

GetCandlesRequest

Запрос исторических свечей.

Field Type Description
figi string Figi-идентификатор инструмента.
from google.protobuf.Timestamp Начало запрашиваемого периода в часовом поясе UTC.
to google.protobuf.Timestamp Окончание запрашиваемого периода в часовом поясе UTC.
interval CandleInterval Интервал запрошенных свечей.

GetCandlesResponse

Список свечей.

Field Type Description
candles Массив объектов HistoricCandle Массив свечей.

HistoricCandle

Информация о свече.

Field Type Description
open Quotation Цена открытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
high Quotation Максимальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
low Quotation Минимальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
close Quotation Цена закрытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
volume int64 Объём торгов в лотах.
time google.protobuf.Timestamp Время свечи в часовом поясе UTC.
is_complete bool Признак завершённости свечи. false значит, свеча за текущие интервал ещё сформирована не полностью.

GetLastPricesRequest

Запрос получения последних цен.

Field Type Description
figi Массив объектов string Массив figi-идентификаторов инструментов.

GetLastPricesResponse

Список последних цен.

Field Type Description
last_prices Массив объектов LastPrice Массив последних цен.

LastPrice

Информация о цене.

Field Type Description
figi string Идентификатор инструмента.
price Quotation Последняя цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
time google.protobuf.Timestamp Время получения последней цены в часовом поясе UTC по времени биржи.

GetOrderBookRequest

Запрос стакана.

Field Type Description
figi string Figi-идентификатор инструмента.
depth int32 Глубина стакана.

GetOrderBookResponse

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

Field Type Description
figi string Figi-идентификатор инструмента.
depth int32 Глубина стакана.
bids Массив объектов Order Множество пар значений на покупку.
asks Массив объектов Order Множество пар значений на продажу.
last_price Quotation Цена последней сделки за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
close_price Quotation Цена закрытия за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
limit_up Quotation Верхний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
limit_down Quotation Нижний лимит цены за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.

GetTradingStatusRequest

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

Field Type Description
figi string Идентификатор инструмента.

GetTradingStatusResponse

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

Field Type Description
figi string Figi-идентификатор инструмента.
trading_status SecurityTradingStatus Статус торговли инструментом.
limit_order_available_flag bool Признак доступности выставления лимитной заявки по инструменту.
market_order_available_flag bool Признак доступности выставления рыночной заявки по инструменту.
api_trade_available_flag bool Признак доступности торгов через API.

GetLastTradesRequest

Запрос последних обезличенных сделок по инструменту на текущий торговый день с максимальным интервалом в 1 час.

Field Type Description
figi string Figi-идентификатор инструмента
from google.protobuf.Timestamp Начало запрашиваемого периода в часовом поясе UTC.
to google.protobuf.Timestamp Окончание запрашиваемого периода в часовом поясе UTC.

GetLastTradesResponse

Последние обезличенные сделки по инструменту на текущий торговый день с максимальным интервалом в 1 час.

Field Type Description
trades Массив объектов Trade Массив сделок

Enums

SubscriptionAction

Тип операции со списком подписок.

Name Number Description
SUBSCRIPTION_ACTION_UNSPECIFIED 0 Статус подписки не определён.
SUBSCRIPTION_ACTION_SUBSCRIBE 1 Подписаться.
SUBSCRIPTION_ACTION_UNSUBSCRIBE 2 Отписаться.

SubscriptionInterval

Интервал свечи.

Name Number Description
SUBSCRIPTION_INTERVAL_UNSPECIFIED 0 Интервал свечи не определён.
SUBSCRIPTION_INTERVAL_ONE_MINUTE 1 Минутные свечи.
SUBSCRIPTION_INTERVAL_FIVE_MINUTES 2 Пятиминутные свечи.

SubscriptionStatus

Результат подписки.

Name Number Description
SUBSCRIPTION_STATUS_UNSPECIFIED 0 Статус подписки не определён.
SUBSCRIPTION_STATUS_SUCCESS 1 Успешно.
SUBSCRIPTION_STATUS_INSTRUMENT_NOT_FOUND 2 Инструмент не найден.
SUBSCRIPTION_STATUS_SUBSCRIPTION_ACTION_IS_INVALID 3 Некорректный статус подписки, список возможных значений: SubscriptionAction.
SUBSCRIPTION_STATUS_DEPTH_IS_INVALID 4 Некорректная глубина стакана, доступные значения: 1, 10, 20, 30, 40, 50.
SUBSCRIPTION_STATUS_INTERVAL_IS_INVALID 5 Некорректный интервал свечей, список возможных значений: SubscriptionInterval.
SUBSCRIPTION_STATUS_LIMIT_IS_EXCEEDED 6 Превышен лимит на общее количество подписок в рамках стрима, подробнее: Лимитная политика.
SUBSCRIPTION_STATUS_INTERNAL_ERROR 7 Внутренняя ошибка сервиса.
SUBSCRIPTION_STATUS_TOO_MANY_REQUESTS 8 Превышен лимит на количество запросов на подписки в течение установленного отрезка времени

TradeDirection

Направление сделки.

Name Number Description
TRADE_DIRECTION_UNSPECIFIED 0 Направление сделки не определено.
TRADE_DIRECTION_BUY 1 Покупка.
TRADE_DIRECTION_SELL 2 Продажа.

CandleInterval

Интервал свечей.

Name Number Description
CANDLE_INTERVAL_UNSPECIFIED 0 Интервал не определён.
CANDLE_INTERVAL_1_MIN 1 1 минута.
CANDLE_INTERVAL_5_MIN 2 5 минут.
CANDLE_INTERVAL_15_MIN 3 15 минут.
CANDLE_INTERVAL_HOUR 4 1 час.
CANDLE_INTERVAL_DAY 5 1 день.

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 Дробная часть суммы, может быть отрицательным числом