package tinkoff.public.invest.api.contract.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Методы сервиса предназначены для получения:<br/>1. Информации об инструментах.<br/>2. Расписания торговых сессий.<br/>3. Календаря выплат купонов по облигациям.<br/>4. Размера гарантийного обеспечения по фьючерсам.<br/>5. Дивидендов по ценной бумаге.
rpc TradingSchedules (, )
instruments.proto:21TradingSchedules — расписания торговых площадок
message
instruments.proto:136Запрос расписания торгов.
optional string exchange = 1
Наименование биржи или расчетного календаря. <br/>Если не передается, возвращается информация по всем доступным торговым площадкам.
optional from = 2
Начало периода по UTC.
optional to = 3
Окончание периода по UTC.
message
instruments.proto:143Список торговых площадок.
repeated exchanges = 1
Список торговых площадок и режимов торгов.
rpc BondBy (, )
instruments.proto:24BondBy — получить облигацию по ее идентификатору
message
instruments.proto:193Информация об облигации.
optional instrument = 1
Информация об облигации.
rpc Bonds (, )
instruments.proto:27Bonds — список облигаций
message
instruments.proto:198Список облигаций.
repeated instruments = 1
Массив облигаций.
rpc GetBondCoupons (, )
instruments.proto:30GetBondCoupons — график выплат купонов по облигации
message
instruments.proto:203Запрос купонов по облигации.
string figi = 1
FIGI-идентификатор инструмента.
optional from = 2
Начало запрашиваемого периода по UTC. Фильтрация по `coupon_date` — дата выплаты купона.
optional to = 3
Окончание запрашиваемого периода по UTC. Фильтрация по `coupon_date` — дата выплаты купона.
string instrument_id = 4
Идентификатор инструмента — `figi` или `instrument_uid`.
message
instruments.proto:211Купоны по облигации.
repeated events = 1
rpc GetBondEvents (, )
instruments.proto:33GetBondEvents — события по облигации
message
instruments.proto:216События по облигации.
optional from = 2
Начало запрашиваемого периода по UTC.
optional to = 3
Окончание запрашиваемого периода по UTC.
string instrument_id = 4
Идентификатор инструмента — `figi` или `instrument_uid`.
GetBondEventsRequest.EventType type = 5
Тип события
message
instruments.proto:232Объект передачи информации о событии облигации.
repeated events = 1
rpc CurrencyBy (, )
instruments.proto:36CurrencyBy — получить валюту по ее идентификатору
message
instruments.proto:287Данные по валюте.
optional instrument = 1
Информация о валюте.
rpc Currencies (, )
instruments.proto:39Currencies — список валют
message
instruments.proto:292Данные по валютам.
repeated instruments = 1
Массив валют.
rpc EtfBy (, )
instruments.proto:42EtfBy — получить инвестиционный фонд по его идентификатору
message
instruments.proto:297Данные по фонду.
optional instrument = 1
Информация о фонде.
rpc Etfs (, )
instruments.proto:45Etfs — список инвестиционных фондов
message
instruments.proto:302Данные по фондам.
repeated instruments = 1
Массив фондов.
rpc FutureBy (, )
instruments.proto:48FutureBy — получить фьючерс по его идентификатору
message
instruments.proto:307Данные по фьючерсу.
optional instrument = 1
Информация о фьючерсу.
rpc Futures (, )
instruments.proto:51Futures — список фьючерсов
message
instruments.proto:312Данные по фьючерсам.
repeated instruments = 1
Массив фьючерсов.
rpc OptionBy (, )
instruments.proto:54OptionBy — получить опцион по его идентификатору
message
instruments.proto:317Данные по опциону.
optional instrument = 1
Информация по опциону.
rpc Options (, )
instruments.proto:57Deprecated Options — список опционов
rpc OptionsBy (, )
instruments.proto:62OptionsBy — список опционов
message
instruments.proto:187Параметры фильтрации опционов.
optional string basic_asset_uid = 1
Идентификатор базового актива опциона. Обязательный параметр.
optional string basic_asset_position_uid = 2
Идентификатор позиции базового актива опциона.
rpc ShareBy (, )
instruments.proto:65ShareBy — получить акцию по ее идентификатору
message
instruments.proto:412Данные по акции.
optional instrument = 1
Информация об акции.
rpc Shares (, )
instruments.proto:68Shares — список акций
message
instruments.proto:417Данные по акциям.
repeated instruments = 1
Массив акций.
rpc Indicatives (, )
instruments.proto:71Indicatives — индикативные инструменты — индексы, товары и другие
message
instruments.proto:1176Запрос справочника индексов и товаров
(message has no fields)
message
instruments.proto:1179Справочник индексов и товаров
repeated instruments = 1
Массив инструментов.
GetAccruedInterests — накопленный купонный доход по облигации
message
instruments.proto:710Запрос НКД по облигации.
string figi = 1
FIGI-идентификатор инструмента.
optional from = 2
Начало запрашиваемого периода по UTC.
optional to = 3
Окончание запрашиваемого периода по UTC.
string instrument_id = 4
Идентификатор инструмента — `figi` или `instrument_uid`.
message
instruments.proto:718НКД облигации.
repeated accrued_interests = 1
Массив операций начисления купонов.
rpc GetFuturesMargin (, )
instruments.proto:77GetFuturesMargin — размера гарантийного обеспечения по фьючерсам
message
instruments.proto:731Запрос информации о фьючерсе
string figi = 1
Идентификатор инструмента.
string instrument_id = 4
Идентификатор инструмента — `figi` или `instrument_uid`.
message
instruments.proto:737Данные по фьючерсу
optional initial_margin_on_buy = 1
Гарантийное обеспечение при покупке.
optional initial_margin_on_sell = 2
Гарантийное обеспечение при продаже.
optional min_price_increment = 3
Шаг цены.
optional min_price_increment_amount = 4
Стоимость шага цены.
rpc GetInstrumentBy (, )
instruments.proto:80GetInstrumentBy — основная информация об инструменте
message
instruments.proto:754Данные по инструменту.
optional instrument = 1
Основная информация об инструменте.
rpc GetDividends (, )
instruments.proto:83GetDividends — события выплаты дивидендов по инструменту
message
instruments.proto:808Запрос дивидендов.
string figi = 1
FIGI-идентификатор инструмента.
optional from = 2
Начало запрашиваемого периода по UTC. Фильтрация происходит по параметру `record_date` — дата фиксации реестра.
optional to = 3
Окончание запрашиваемого периода по UTC. Фильтрация происходит по параметру `record_date` — дата фиксации реестра.
string instrument_id = 4
Идентификатор инструмента — `figi` или `instrument_uid`.
message
instruments.proto:816Дивиденды.
repeated dividends = 1
rpc GetAssetBy (, )
instruments.proto:86GetAssetBy — получить актив по его идентификатору
message
instruments.proto:848Запрос актива по идентификатору.
string id = 1
UID-идентификатор актива.
message
instruments.proto:853Данные по активу.
optional asset = 1
Актив.
rpc GetAssets (, )
instruments.proto:90GetAssets — список активов Метод работает для всех инструментов, кроме срочных — фьючерсов и опционов
message
instruments.proto:858Запрос списка активов.
optional InstrumentType instrument_type = 1
optional InstrumentStatus instrument_status = 2
Статус запрашиваемых инструментов. [Возможные значения](#instrumentstatus).
message
instruments.proto:865Список активов.
repeated assets = 1
Активы.
rpc GetFavorites (, )
instruments.proto:93GetFavorites — получить список избранных инструментов
message
instruments.proto:1068Запрос списка избранных инструментов, входные параметры не требуются.
optional string group_id = 1
Уникальный идентификатор группы.
message
instruments.proto:1073В ответ передается список избранных инструментов в качестве массива.
repeated favorite_instruments = 1
Массив инструментов.
optional string group_id = 2
Уникальный идентификатор группы.
rpc EditFavorites (, )
instruments.proto:96EditFavorites — отредактировать список избранных инструментов
message
instruments.proto:1093Запрос редактирования списка избранных инструментов.
repeated instruments = 1
Массив инструментов.
EditFavoritesActionType action_type = 6
Тип действия со списком.
optional string group_id = 7
Уникальный идентификатор группы.
message
instruments.proto:1113Результат редактирования списка избранных инструментов.
repeated favorite_instruments = 1
Массив инструментов.
optional string group_id = 2
Уникальный идентификатор группы.
CreateFavoriteGroup — создать новую группу избранных инструментов
message
instruments.proto:1119Запрос создания новой группы избранных инструментов.
string group_name = 1
Название группы, не более 255 символов.
string group_color = 2
Цвет группы. Принимает значения в HEX-формате, от "000000" до "FFFFFF"
optional string note = 3
Описание
message
instruments.proto:1125string group_id = 1
Уникальный идентификатор группы.
string group_name = 2
Название группы.
DeleteFavoriteGroup — удалить группу избранных инструментов
message
instruments.proto:1131Запрос удаления избранной группы
string group_id = 1
Уникальный идентификатор группы.
message
instruments.proto:1135(message has no fields)
GetFavoriteGroups — список групп избранных инструментов
message
instruments.proto:1139Запрос получения списка избранных групп
repeated string instrument_id = 1
Массив идентификаторов инструментов. Принимает значение `figi` или `instrument_uid`. Если в группе будет хотя бы один из инструментов массива, то в ответе у группы вернется признак `containsInstrument = true`.
repeated string excluded_group_id = 2
Массив идентификаторов групп, которые необходимо исключить из ответа.
message
instruments.proto:1145Избранные группы
repeated groups = 1
Массив групп избранных списков инструментов.
rpc GetCountries (, )
instruments.proto:108GetCountries — список стран
message
instruments.proto:1168Запрос справочника стран.
(message has no fields)
message
instruments.proto:1171Справочник стран.
repeated countries = 1
Массив стран.
rpc FindInstrument (, )
instruments.proto:111FindInstrument — найти инструмент
message
instruments.proto:1206Запрос на поиск инструментов.
string query = 1
Строка поиска.
optional InstrumentType instrument_kind = 2
Фильтр по типу инструмента.
optional bool api_trade_available_flag = 3
Фильтр для отображения только торговых инструментов.
message
instruments.proto:1213Результат поиска инструментов.
repeated instruments = 1
Массив инструментов, удовлетворяющих условиям поиска.
rpc GetBrands (, )
instruments.proto:114GetBrands — список брендов
message
instruments.proto:1239Запрос списка брендов.
optional paging = 1
Настройки пагинации.
message
instruments.proto:1249Список брендов.
repeated brands = 1
Массив брендов.
optional paging = 2
Данные по пагинации.
rpc GetBrandBy (, )
instruments.proto:117GetBrandBy — получить бренд по его идентификатору
message
instruments.proto:1244Запрос бренда.
string id = 1
UID-идентификатор бренда.
GetAssetFundamentals — фундаментальные показатели по активу
message
instruments.proto:1255Запрос фундаментальных показателей
repeated string assets = 1
Массив идентификаторов активов, не более 100 шт.
message
instruments.proto:1260Фундаментальные показатели
repeated fundamentals = 1
rpc GetAssetReports (, )
instruments.proto:123GetAssetReports — расписания выхода отчетностей эмитентов
message
instruments.proto:1326Запрос отчетов эмитентов
string instrument_id = 1
Идентификатор инструмента в формате UID.
optional from = 2
Начало запрашиваемого периода по UTC.
optional to = 3
Окончание запрашиваемого периода по UTC.
message
instruments.proto:1333Отчеты эмитентов
repeated events = 1
Массив событий по облигации.
GetConsensusForecasts — мнения аналитиков по инструменту
message
instruments.proto:1355Запрос консенсус-прогнозов
optional paging = 1
Настройки пагинации.
message
instruments.proto:1360Консенсус-прогнозы
repeated items = 1
Массив прогнозов.
optional page = 2
Данные по пагинации.
rpc GetForecastBy (, )
instruments.proto:129GetForecastBy — прогнозы инвестдомов по инструменту
message
instruments.proto:1390Запрос прогнозов инвестдомов.
string instrument_id = 1
Идентификатор инструмента.
message
instruments.proto:1395Прогнозы инвестдомов по инструменту.
repeated targets = 1
Массив прогнозов.
optional consensus = 2
Согласованный прогноз.
rpc GetRiskRates (, )
instruments.proto:132GetRiskRates — ставки риска по инструменту
message
instruments.proto:1431Запрос ставок риска
repeated string instrument_id = 1
Идентификаторы инструментов.
message
instruments.proto:1437Ставки риска
repeated instrument_risk_rates = 1
Сервис для получения биржевой информации:<br/> 1. Свечи.<br/> 2. Стаканы.<br/> 3. Торговые статусы.<br/> 4. Лента сделок.
rpc GetCandles (, )
marketdata.proto:19GetCandles — исторические свечи по инструменту
message
marketdata.proto:351Запрос исторических свечей.
optional string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
optional from = 2
Начало запрашиваемого периода по UTC.
optional to = 3
Окончание запрашиваемого периода по UTC.
CandleInterval interval = 4
Интервал запрошенных свечей.
optional string instrument_id = 5
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
optional GetCandlesRequest.CandleSource candle_source_type = 7
Тип источника свечи.
optional int32 limit = 10
Максимальное количество свечей в ответе.
message
marketdata.proto:395Список свечей.
repeated candles = 1
Массив свечей.
rpc GetLastPrices (, )
marketdata.proto:22GetLastPrices — цены последних сделок по инструментам
message
marketdata.proto:412Запрос получения цен последних сделок.
repeated string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
repeated string instrument_id = 2
Массив идентификаторов инструмента. Принимает значения `figi` или `instrument_uid`.
LastPriceType last_price_type = 3
Тип запрашиваемой последней цены.
optional InstrumentStatus instrument_status = 9
Статус запрашиваемых инструментов. [Возможные значения](#instrumentstatus).
message
marketdata.proto:420Список цен последних сделок.
repeated last_prices = 1
Массив цен последних сделок.
rpc GetOrderBook (, )
marketdata.proto:25GetOrderBook — стакан по инструменту
message
marketdata.proto:434Запрос стакана.
optional string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
int32 depth = 2
Глубина стакана.
optional string instrument_id = 3
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
message
marketdata.proto:441Информация о стакане.
string figi = 1
FIGI-идентификатор инструмента.
int32 depth = 2
Глубина стакана.
repeated bids = 3
Множество пар значений на покупку.
repeated asks = 4
Множество пар значений на продажу.
optional last_price = 5
Цена последней сделки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional close_price = 6
Цена закрытия за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional limit_up = 7
Верхний лимит цены за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional limit_down = 8
Нижний лимит цены за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional last_price_ts = 21
Время получения цены последней сделки.
optional close_price_ts = 22
Время получения цены закрытия.
optional orderbook_ts = 23
Время формирования стакана на бирже.
string instrument_uid = 9
UID инструмента.
rpc GetTradingStatus (, )
marketdata.proto:28GetTradingStatus — статус торгов по инструменту
message
marketdata.proto:457Запрос получения торгового статуса.
optional string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
optional string instrument_id = 2
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
GetTradingStatuses — статус торгов по инструментам
message
marketdata.proto:463Запрос получения торгового статуса.
repeated string instrument_id = 1
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
message
marketdata.proto:468Информация о торговом статусе.
repeated trading_statuses = 1
Массив информации о торговых статусах.
rpc GetLastTrades (, )
marketdata.proto:35GetLastTrades — обезличенные сделки Обезличенные сделки по инструменту. Метод гарантирует получение информации за последний час.
message
marketdata.proto:486Запрос обезличенных сделок за последний час.
optional string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
optional from = 2
Начало запрашиваемого периода по UTC.
optional to = 3
Окончание запрашиваемого периода по UTC.
optional string instrument_id = 4
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
TradeSourceType trade_source = 5
Тип источника сделок. Значение по умолчанию — `TRADE_SOURCE_ALL`, все сделки.
message
marketdata.proto:495Обезличенных сделок за последний час.
repeated trades = 1
Массив сделок.
rpc GetClosePrices (, )
marketdata.proto:38GetClosePrices — цены закрытия торговой сессии по инструментам
message
marketdata.proto:503Запрос цен закрытия торговой сессии по инструментам.
repeated instruments = 1
Массив по инструментам.
optional InstrumentStatus instrument_status = 9
Статус запрашиваемых инструментов. [Возможные значения](#instrumentstatus).
message
marketdata.proto:514Цены закрытия торговой сессии по инструментам.
repeated close_prices = 1
Массив по инструментам.
rpc GetTechAnalysis (, )
marketdata.proto:41GetTechAnalysis — технические индикаторы по инструменту
message
marketdata.proto:527GetTechAnalysisRequest.IndicatorType indicator_type = 1
Тип технического индикатора.
string instrument_uid = 2
UID инструмента.
optional from = 3
Начало запрашиваемого периода по UTC.
optional to = 4
Окончание запрашиваемого периода по UTC.
GetTechAnalysisRequest.IndicatorInterval interval = 5
Интервал, за который рассчитывается индикатор.
GetTechAnalysisRequest.TypeOfPrice type_of_price = 6
Тип цены, который используется при расчете индикатора.
int32 length = 7
Торговый период, за который рассчитывается индикатор.
optional deviation = 8
Параметры отклонения.
optional smoothing = 9
Параметры сглаживания.
message
marketdata.proto:585repeated technical_indicators = 1
Массив значений результатов технического анализа.
rpc MarketDataStream (stream , stream )
marketdata.proto:46MarketDataStream — bidirectional стрим предоставления биржевой информации
message
marketdata.proto:53Запрос подписки или отписки на определенные биржевые данные.
oneof payload
subscribe_candles_request = 1
Запрос подписки на свечи.
subscribe_order_book_request = 2
Запрос подписки на стаканы.
subscribe_trades_request = 3
Запрос подписки на ленту обезличенных сделок.
subscribe_info_request = 4
Запрос подписки на торговые статусы инструментов.
subscribe_last_price_request = 5
Запрос подписки на цены последних сделок.
get_my_subscriptions = 6
Запрос своих подписок.
ping = 7
Запрос проверки активности соединения.
ping_settings = 15
Запрос настройки пинга.
rpc MarketDataServerSideStream (, stream )
marketdata.proto:49MarketDataServerSideStream — server-side стрим предоставления биржевой информации
message
marketdata.proto:66optional subscribe_candles_request = 1
Запрос подписки на свечи.
optional subscribe_order_book_request = 2
Запрос подписки на стаканы.
optional subscribe_trades_request = 3
Запрос подписки на ленту обезличенных сделок.
optional subscribe_info_request = 4
Запрос подписки на торговые статусы инструментов.
optional subscribe_last_price_request = 5
Запрос подписки на цены последних сделок.
optional ping_settings = 15
Запрос настройки пинга.
С помощью методов сервиса можно получить:<br/><br/> **1**. Список операций по счету.<br/> **2**. Портфель по счету.<br/> **3**. Позиции ценных бумаг на счете.<br/> **4**. Доступный остаток для вывода средств.<br/> **5**. Различные отчеты.
rpc GetOperations (, )
operations.proto:21GetOperations — список операций по счету При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems).
rpc GetPortfolio (, )
operations.proto:24GetPortfolio — портфель по счету
rpc GetPositions (, )
operations.proto:27GetPositions — список позиций по счету
rpc GetWithdrawLimits (, )
operations.proto:30GetWithdrawLimits — доступный остаток для вывода средств
rpc GetBrokerReport (, )
operations.proto:33GetBrokerReport — брокерский отчет.
message
operations.proto:222oneof payload
generate_broker_report_request = 1
get_broker_report_request = 2
message
operations.proto:229oneof payload
generate_broker_report_response = 1
get_broker_report_response = 2
GetDividendsForeignIssuer — отчет «Справка о доходах за пределами РФ»
message
operations.proto:363oneof payload
generate_div_foreign_issuer_report = 1
Объект запроса формирования отчета.
get_div_foreign_issuer_report = 2
Объект запроса сформированного отчета.
message
operations.proto:370oneof payload
generate_div_foreign_issuer_report_response = 1
Объект результата задачи запуска формирования отчета.
div_foreign_issuer_report = 2
Отчет «Справка о доходах за пределами РФ».
GetOperationsByCursor — список операций по счету с пагинацией При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems).
rpc PortfolioStream (, stream )
operations.proto:45PortfolioStream — стрим обновлений портфеля
message
operations.proto:419Запрос установки stream-соединения.
repeated string accounts = 1
Массив идентификаторов счетов пользователя.
optional ping_settings = 15
Запрос настройки пинга.
message
operations.proto:425Информация по позициям и доходностям портфелей.
oneof payload
subscriptions = 1
Объект результата подписки.
portfolio = 2
Объект стриминга портфеля.
ping = 3
Проверка активности стрима.
rpc PositionsStream (, stream )
operations.proto:48PositionsStream — стрим обновлений информации по изменению позиций портфеля
message
operations.proto:524Запрос установки stream-соединения позиций.
repeated string accounts = 1
Массив идентификаторов счетов пользователя.
bool with_initial_positions = 3
Получение состояния позиций на момент подключения.
optional ping_settings = 15
Запрос настройки пинга.
message
operations.proto:531Информация по изменению позиций портфеля.
oneof payload
subscriptions = 1
Объект результата подписки.
position = 2
Объект стриминга позиций.
ping = 3
Проверка активности стрима.
initial_positions = 5
Текущие позиции.
service OrdersService
orders.proto:24Сервис предназначен для работы с торговыми поручениями:<br/> **1**. выставление;<br/> **2**. отмена;<br/> **3**. получение статуса;<br/> **4**. расчет полной стоимости;<br/> **5**. получение списка заявок.
rpc PostOrder (, )
orders.proto:28PostOrder — выставить заявку
rpc PostOrderAsync (, )
orders.proto:32PostOrderAsync — выставить заявку асинхронным методом Особенности работы приведены в [статье](/invest/services/orders/async).
rpc CancelOrder (, )
orders.proto:35CancelOrder — отменить заявку
rpc GetOrderState (, )
orders.proto:38GetOrderState — получить статус торгового поручения
rpc GetOrders (, )
orders.proto:41GetOrders — получить список активных заявок по счету
rpc ReplaceOrder (, )
orders.proto:44ReplaceOrder — изменить выставленную заявку
rpc GetMaxLots (, )
orders.proto:47GetMaxLots — расчет количества доступных для покупки/продажи лотов
rpc GetOrderPrice (, )
orders.proto:50GetOrderPrice — получить предварительную стоимость для лимитной заявки
message
orders.proto:248Запрос получения предварительной стоимости заявки
string account_id = 1
Номер счета
string instrument_id = 2
Идентификатор инструмента, принимает значения Figi или instrument_uid
optional price = 3
Цена инструмента
OrderDirection direction = 12
Направление заявки
int64 quantity = 13
Количество лотов
message
orders.proto:257Предварительная стоимость заявки
optional total_order_amount = 1
Итоговая стоимость заявки
optional initial_order_amount = 5
Стоимость заявки без комиссий, НКД, ГО (для фьючерсов — стоимость контрактов)
int64 lots_requested = 3
Запрошено лотов
optional executed_commission = 7
Общая комиссия
optional executed_commission_rub = 8
Общая комиссия в рублях
optional service_commission = 9
Сервисная комиссия
optional deal_commission = 10
Комиссия за проведение сделки
oneof instrument_extra
extra_bond = 12
Дополнительная информация по облигациям
extra_future = 13
Дополнительная информация по фьючерсам
rpc TradesStream (, stream )
orders.proto:18TradesStream — стрим сделок пользователя
message
orders.proto:54Запрос установки соединения.
repeated string accounts = 1
Идентификаторы счетов.
optional int32 ping_delay_ms = 15
Задержка (пинг) сообщений: 5000–180 000 миллисекунд. Значение по умолчанию — 120 000.
message
orders.proto:60Информация о торговых поручениях.
oneof payload
order_trades = 1
Информация об исполнении торгового поручения.
ping = 2
Проверка активности стрима.
subscription = 3
Ответ на запрос на подписку.
rpc OrderStateStream (, stream )
orders.proto:21OrderStateStream — стрим поручений пользователя Перед работой прочитайте [статью](/invest/services/orders/orders_state_stream).
message
orders.proto:282Запрос установки стрим-соединения торговых поручений
repeated string accounts = 1
Идентификаторы счетов.
optional int32 ping_delay_millis = 15
Задержка (пинг) сообщений: 1000-120 000 миллисекунд. Значение по умолчанию — 120 000.
message
orders.proto:297Информация по заявкам
oneof payload
order_state = 1
Информация об исполнении торгового поручения.
ping = 2
Проверка активности стрима.
subscription = 3
Ответ на запрос на подписку.
service SandboxService
sandbox.proto:18Методы для работы с песочницей T-Invest API
rpc OpenSandboxAccount (, )
sandbox.proto:21OpenSandboxAccount — зарегистрировать счет
message
sandbox.proto:73Запрос открытия счета в песочнице.
optional string name = 1
Название счета
message
sandbox.proto:78Номер открытого счета в песочнице.
string account_id = 1
Номер счета
rpc GetSandboxAccounts (, )
sandbox.proto:24GetSandboxAccounts — счета пользователя
rpc CloseSandboxAccount (, )
sandbox.proto:27CloseSandboxAccount — закрыть счет
message
sandbox.proto:83Запрос закрытия счета в песочнице.
string account_id = 1
Номер счета
message
sandbox.proto:88Результат закрытия счета в песочнице.
пустой ответ
(message has no fields)
rpc PostSandboxOrder (, )
sandbox.proto:30PostSandboxOrder — выставить заявку
PostSandboxOrderAsync — выставить заявку асинхронным методом Особенности работы приведены в [статье](/invest/services/orders/async).
rpc ReplaceSandboxOrder (, )
sandbox.proto:37ReplaceSandboxOrder — изменить выставленную заявку
rpc GetSandboxOrders (, )
sandbox.proto:40GetSandboxOrders — получить список активных заявок по счету
rpc CancelSandboxOrder (, )
sandbox.proto:43CancelSandboxOrder — отменить заявку
rpc GetSandboxOrderState (, )
sandbox.proto:46GetSandboxOrderState — получить статус торгового поручения
rpc GetSandboxPositions (, )
sandbox.proto:49GetSandboxPositions — список позиций по счету
rpc GetSandboxOperations (, )
sandbox.proto:53GetSandboxOperations — список операций по счету При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems).
GetSandboxOperationsByCursor — список операций по счету с пагинацией При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems).
rpc GetSandboxPortfolio (, )
sandbox.proto:60GetSandboxPortfolio — портфель по счету
rpc SandboxPayIn (, )
sandbox.proto:63SandboxPayIn — пополнить счет.
message
sandbox.proto:93Запрос пополнения счета в песочнице.
string account_id = 1
Номер счета
optional amount = 2
Сумма пополнения счета в рублях
message
sandbox.proto:99Результат пополнения счета, текущий баланс.
optional balance = 1
Текущий баланс счета
GetSandboxWithdrawLimits — доступный остаток для вывода средств
rpc GetSandboxMaxLots (, )
sandbox.proto:69GetSandboxMaxLots — расчет количества доступных для покупки/продажи лотов
service SignalService
signals.proto:16Сервис для получения технических сигналов и мнений аналитиков по инструментам.
rpc GetStrategies (, )
signals.proto:19GetStrategies — стратегии
message
signals.proto:26Запрос стратегий.
optional string strategy_id = 1
Идентификатор стратегии.
message
signals.proto:31Стратегии
repeated strategies = 1
rpc GetSignals (, )
signals.proto:22GetSignals — сигналы
message
signals.proto:52Запрос сигналов.
optional string signal_id = 1
Идентификатор сигнала.
optional string strategy_id = 2
Идентификатор стратегии.
optional StrategyType strategy_type = 3
Тип стратегии.
optional string instrument_uid = 4
Идентификатор бумаги.
optional from = 5
Дата начала запрашиваемого интервала по UTC.
optional to = 6
Дата конца запрашиваемого интервала по UTC.
optional SignalDirection direction = 7
Направление сигнала.
optional SignalState active = 8
Состояние сигнала.
optional paging = 9
Настройки пагинации.
message
signals.proto:65Сигналы.
repeated signals = 1
Массив сигналов.
optional paging = 2
Данные по пагинации.
Сервис для работы со стоп-заявками: выставление, отмена, получение списка стоп-заявок.
rpc PostStopOrder (, )
stoporders.proto:19PostStopOrder — выставить стоп-заявку
message
stoporders.proto:29Запрос выставления стоп-заявки.
optional string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
int64 quantity = 2
Количество лотов.
optional price = 3
Цена за 1 инструмент биржевой заявки, которая будет выставлена при срабатывании по достижению `stop_price`. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
optional stop_price = 4
Стоп-цена заявки за 1 инструмент. При достижении стоп-цены происходит активация стоп-заявки, в результате чего выставляется биржевая заявка. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
StopOrderDirection direction = 5
Направление операции.
string account_id = 6
Номер счета.
StopOrderExpirationType expiration_type = 7
Тип экспирации заявки.
StopOrderType stop_order_type = 8
Тип заявки.
optional expire_date = 9
Дата и время окончания действия стоп-заявки по UTC. Для `ExpirationType = GoodTillDate` заполнение обязательно, для `GoodTillCancel` игнорируется.
string instrument_id = 10
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
ExchangeOrderType exchange_order_type = 11
Тип дочерней биржевой заявки.
TakeProfitType take_profit_type = 12
Подтип стоп-заявки — `TakeProfit`.
optional trailing_data = 13
Массив с параметрами трейлинг-стопа.
PriceType price_type = 14
Тип цены.
string order_id = 15
Идентификатор запроса выставления поручения для целей идемпотентности в формате `UID`. Максимальная длина — 36 символов.
message
stoporders.proto:54Результат выставления стоп-заявки.
string stop_order_id = 1
Уникальный идентификатор стоп-заявки.
string order_request_id = 2
Идентификатор ключа идемпотентности, переданный клиентом, в формате `UID`. Максимальная длина 36 — символов.
optional response_metadata = 254
Метадата.
rpc GetStopOrders (, )
stoporders.proto:22GetStopOrders — получить список активных стоп-заявок по счету
message
stoporders.proto:61Запрос получения списка активных стоп-заявок.
string account_id = 1
Идентификатор счета клиента.
StopOrderStatusOption status = 2
Статус заявок.
optional from = 3
Левая граница.
optional to = 4
Правая граница.
message
stoporders.proto:69Список активных стоп-заявок.
repeated stop_orders = 1
Массив стоп-заявок по счету.
rpc CancelStopOrder (, )
stoporders.proto:25CancelStopOrder — отменить стоп-заявку
message
stoporders.proto:74Запрос отмены выставленной стоп-заявки.
string account_id = 1
Идентификатор счета клиента.
string stop_order_id = 2
Уникальный идентификатор стоп-заявки.
message
stoporders.proto:80Результат отмены выставленной стоп-заявки.
optional time = 1
Время отмены заявки по UTC.
service UsersService
users.proto:16С помощью сервиса можно получить: <br/> 1. список счетов пользователя; <br/> 2. маржинальные показатели по счeту.
rpc GetAccounts (, )
users.proto:21GetAccounts — счета пользователя Получить список счетов.
rpc GetMarginAttributes (, )
users.proto:25GetMarginAttributes — маржинальные показатели по счeту Метод позволяет получить маржинальные показатели и ликвидность по заданному счeту.
message
users.proto:91Запрос маржинальных показателей по счeту.
string account_id = 1
Идентификатор счeта пользователя.
message
users.proto:98Маржинальные показатели по счeту.
optional liquid_portfolio = 1
Ликвидная стоимость портфеля. [Подробнее про ликвидный портфель](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q4).
optional starting_margin = 2
Начальная маржа — начальное обеспечение для совершения новой сделки. [Подробнее про начальную и минимальную маржу](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q6).
optional minimal_margin = 3
Минимальная маржа — это минимальное обеспечение для поддержания позиции, которую вы уже открыли. [Подробнее про начальную и минимальную маржу](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q6).
optional funds_sufficiency_level = 4
Уровень достаточности средств. Соотношение стоимости ликвидного портфеля к начальной марже.
optional amount_of_missing_funds = 5
Объем недостающих средств. Разница между стартовой маржой и ликвидной стоимости портфеля.
optional corrected_margin = 6
Скорректированная маржа. Начальная маржа, в которой плановые позиции рассчитываются с учeтом активных заявок на покупку позиций лонг или продажу позиций шорт.
rpc GetUserTariff (, )
users.proto:29GetUserTariff — тариф пользователя Получить информацию о текущих лимитах на подклчение, согласно текущему тарифу пользователя.
message
users.proto:120Запрос текущих лимитов пользователя.
(message has no fields)
message
users.proto:124Текущие лимиты пользователя.
repeated unary_limits = 1
Массив лимитов пользователя по unary-запросам.
repeated stream_limits = 2
Массив лимитов пользователей для stream-соединений.
rpc GetInfo (, )
users.proto:33GetInfo — информация о пользователе Получить информацию о пользователе: тариф, признак квалификации, пройденные тесты и др.
message
users.proto:143Запрос информации о пользователе.
(message has no fields)
message
users.proto:147Информация о пользователе.
bool prem_status = 1
Признак премиум клиента.
bool qual_status = 2
Признак квалифицированного инвестора.
repeated string qualified_for_work_with = 3
Набор требующих тестирования инструментов и возможностей, с которыми может работать пользователь. [Подробнее](/invest/services/accounts/faq_users).
string tariff = 4
Наименование тарифа пользователя.
string user_id = 9
Идентификатор пользователя.
string risk_level_code = 12
Категория риска.
Уровень доступа к счeту.
Used in:
ACCOUNT_ACCESS_LEVEL_UNSPECIFIED = 0
Уровень доступа не определeн.
ACCOUNT_ACCESS_LEVEL_FULL_ACCESS = 1
Полный доступ к счeту.
ACCOUNT_ACCESS_LEVEL_READ_ONLY = 2
Доступ с уровнем прав «только чтение».
ACCOUNT_ACCESS_LEVEL_NO_ACCESS = 3
Доступа нет.
message
users.proto:48Информация о счeте.
Used in:
string id = 1
Идентификатор счeта.
AccountType type = 2
Тип счeта.
string name = 3
Название счeта.
AccountStatus status = 4
Статус счeта.
optional opened_date = 5
Дата открытия счeта в часовом поясе UTC.
optional closed_date = 6
Дата закрытия счeта в часовом поясе UTC.
AccessLevel access_level = 7
Уровень доступа к текущему счeту (определяется токеном).
Статус счeта.
Used in: ,
ACCOUNT_STATUS_UNSPECIFIED = 0
Статус счeта не определeн.
ACCOUNT_STATUS_NEW = 1
Новый, в процессе открытия.
ACCOUNT_STATUS_OPEN = 2
Открытый и активный счeт.
ACCOUNT_STATUS_CLOSED = 3
Закрытый счeт.
ACCOUNT_STATUS_ALL = 4
Все счета.
message
operations.proto:441Счет клиента.
Used in:
string account_id = 1
Идентификатор счета.
PortfolioSubscriptionStatus subscription_status = 6
Результат подписки.
Тип счeта.
Used in:
ACCOUNT_TYPE_UNSPECIFIED = 0
Тип аккаунта не определeн.
ACCOUNT_TYPE_TINKOFF = 1
Брокерский счeт Т-Инвестиций.
ACCOUNT_TYPE_TINKOFF_IIS = 2
ИИС.
ACCOUNT_TYPE_INVEST_BOX = 3
Инвесткопилка.
ACCOUNT_TYPE_INVEST_FUND = 4
Фонд денежного рынка.
message
instruments.proto:723Операция начисления купонов.
Used in:
optional date = 1
Дата и время выплаты по UTC.
optional value = 2
Величина выплаты.
optional value_percent = 3
Величина выплаты в процентах от номинала.
optional nominal = 4
Номинал облигации.
message
instruments.proto:893Информация об активе.
Used in:
string uid = 1
Уникальный идентификатор актива.
AssetType type = 2
Тип актива.
string name = 3
Наименование актива.
repeated instruments = 4
Массив идентификаторов инструментов.
message
instruments.proto:948Облигация.
Used in:
optional current_nominal = 1
Текущий номинал.
string borrow_name = 2
Наименование заемщика.
optional issue_size = 3
Объем эмиссии облигации (стоимость).
optional nominal = 4
Номинал облигации.
string nominal_currency = 5
Валюта номинала.
string issue_kind = 6
Форма выпуска облигации.
string interest_kind = 7
Форма дохода облигации.
int32 coupon_quantity_per_year = 8
Количество выплат в год.
bool indexed_nominal_flag = 9
Признак облигации с индексируемым номиналом.
bool subordinated_flag = 10
Признак субординированной облигации.
bool collateral_flag = 11
Признак обеспеченной облигации.
bool tax_free_flag = 12
Признак показывает, что купоны облигации не облагаются налогом — для mass market.
bool amortization_flag = 13
Признак облигации с амортизацией долга.
bool floating_coupon_flag = 14
Признак облигации с плавающим купоном.
bool perpetual_flag = 15
Признак бессрочной облигации.
optional maturity_date = 16
Дата погашения облигации.
string return_condition = 17
Описание и условия получения дополнительного дохода.
optional state_reg_date = 18
Дата выпуска облигации.
optional placement_date = 19
Дата размещения облигации.
optional placement_price = 20
Цена размещения облигации.
optional issue_size_plan = 21
Объявленное количество, шт.
message
instruments.proto:1032Клиринговый сертификат участия.
Used in:
optional nominal = 1
Номинал.
string nominal_currency = 2
Валюта номинала.
message
instruments.proto:910Валюта.
Used in:
string base_currency = 1
ISO-код валюты.
message
instruments.proto:997Фонд.
Used in:
optional total_expense = 1
Суммарные расходы фонда в процентах.
optional hurdle_rate = 2
Барьерная ставка доходности, после которой фонд имеет право на perfomance fee — в процентах.
optional performance_fee = 3
Комиссия за успешные результаты фонда в процентах.
optional fixed_commission = 4
Фиксированная комиссия за управление в процентах.
string payment_type = 5
Тип распределения доходов от выплат по бумагам.
bool watermark_flag = 6
Признак необходимости выхода фонда в плюс для получения комиссии.
optional buy_premium = 7
Премия (надбавка к цене) при покупке доли в фонде — в процентах.
optional sell_discount = 8
Ставка дисконта (вычет из цены) при продаже доли в фонде — в процентах.
bool rebalancing_flag = 9
Признак ребалансируемости портфеля фонда.
string rebalancing_freq = 10
Периодичность ребалансировки.
string management_type = 11
Тип управления.
string primary_index = 12
Индекс, который реплицирует (старается копировать) фонд.
string focus_type = 13
База ETF.
bool leveraged_flag = 14
Признак использования заемных активов (плечо).
optional num_share = 15
Количество акций в обращении.
bool ucits_flag = 16
Признак обязательства по отчетности перед регулятором.
optional released_date = 17
Дата выпуска.
string description = 18
Описание фонда.
string primary_index_description = 19
Описание индекса, за которым следует фонд.
string primary_index_company = 20
Основные компании, в которые вкладывается фонд.
optional index_recovery_period = 21
Срок восстановления индекса после просадки.
string inav_code = 22
IVAV-код.
bool div_yield_flag = 23
Признак наличия дивидендной доходности.
optional expense_commission = 24
Комиссия на покрытие расходов фонда в процентах.
optional primary_index_tracking_error = 25
Ошибка следования за индексом в процентах.
string rebalancing_plan = 26
Плановая ребалансировка портфеля.
string tax_rate = 27
Ставки налогообложения дивидендов и купонов.
repeated rebalancing_dates = 28
Даты ребалансировок.
string issue_kind = 29
Форма выпуска.
optional nominal = 30
Номинал.
string nominal_currency = 31
Валюта номинала.
message
instruments.proto:869Used in:
string uid = 1
Уникальный идентификатор актива.
AssetType type = 2
Тип актива.
string name = 3
Наименование актива.
string name_brief = 4
Короткое наименование актива.
string description = 5
Описание актива.
optional deleted_at = 6
Дата и время удаления актива.
repeated string required_tests = 7
Тестирование клиентов.
oneof ext
currency = 8
Валюта. Обязательно и заполняется только для `type = ASSET_TYPE_CURRENCY`.
security = 9
Ценная бумага. Обязательно и заполняется только для `type = ASSET_TYPE_SECURITY`.
string gos_reg_code = 10
Номер государственной регистрации.
string cfi = 11
Код CFI.
string code_nsd = 12
Код НРД инструмента.
string status = 13
Статус актива.
optional brand = 14
Бренд.
optional updated_at = 15
Дата и время последнего обновления записи.
string br_code = 16
Код типа ц.б. по классификации Банка России.
string br_code_name = 17
Наименование кода типа ц.б. по классификации Банка России.
repeated instruments = 18
Массив идентификаторов инструментов.
message
instruments.proto:1050Идентификаторы инструмента.
Used in: ,
string uid = 1
UID-идентификатор инструмента.
string figi = 2
FIGI-идентификатор инструмента.
string instrument_type = 3
Тип инструмента.
string ticker = 4
Тикер инструмента.
string class_code = 5
Класс-код (секция торгов).
repeated links = 6
Массив связанных инструментов.
InstrumentType instrument_kind = 10
Тип инструмента.
string position_uid = 11
ID позиции.
message
instruments.proto:915Ценная бумага.
Used in:
string isin = 1
ISIN-идентификатор ценной бумаги.
string type = 2
Тип ценной бумаги.
InstrumentType instrument_kind = 10
Тип инструмента.
oneof ext
share = 3
Акция. Заполняется только для акций — тип актива `asset.type = ASSET_TYPE_SECURITY` и `security.type = share`.
bond = 4
Облигация. Заполняется только для облигаций — тип актива `asset.type = ASSET_TYPE_SECURITY` и `security.type = bond`.
sp = 5
Структурная нота. Заполняется только для структурных продуктов — тип актива `asset.type = ASSET_TYPE_SECURITY` и `security.type = sp`.
etf = 6
Фонд. Заполняется только для фондов — тип актива `asset.type = ASSET_TYPE_SECURITY` и `security.type = etf`.
clearing_certificate = 7
Клиринговый сертификат участия. Заполняется только для клиринговых сертификатов — тип актива `asset.type = ASSET_TYPE_SECURITY` и security.type = `clearing_certificate`.
message
instruments.proto:929Акция.
Used in:
ShareType type = 1
Тип акции.
optional issue_size = 2
Объем выпуска (шт.).
optional nominal = 3
Номинал.
string nominal_currency = 4
Валюта номинала.
string primary_index = 5
Индекс (Bloomberg).
optional dividend_rate = 6
Ставка дивиденда (для привилегированных акций).
string preferred_share_type = 7
Тип привилегированных акций.
optional ipo_date = 8
Дата IPO.
optional registry_date = 9
Дата регистрации.
bool div_yield_flag = 10
Признак наличия дивидендной доходности.
string issue_kind = 11
Форма выпуска ФИ.
optional placement_date = 12
Дата размещения акции.
string repres_isin = 13
ISIN базового актива.
optional issue_size_plan = 14
Объявленное количество, шт.
optional total_float = 15
Количество акций в свободном обращении.
message
instruments.proto:973Структурная нота.
Used in:
string borrow_name = 1
Наименование заемщика.
optional nominal = 2
Номинал.
string nominal_currency = 3
Валюта номинала.
StructuredProductType type = 4
Тип структурной ноты.
string logic_portfolio = 5
Стратегия портфеля.
AssetType asset_type = 6
Тип базового актива.
string basic_asset = 7
Вид базового актива в зависимости от типа базового актива.
optional safety_barrier = 8
Барьер сохранности в процентах.
optional maturity_date = 9
Дата погашения.
optional issue_size_plan = 10
Объявленное количество, шт.
optional issue_size = 11
Объем размещения.
optional placement_date = 12
Дата размещения ноты.
string issue_kind = 13
Форма выпуска.
Тип актива.
Used in: , ,
ASSET_TYPE_UNSPECIFIED = 0
Тип не определен.
ASSET_TYPE_CURRENCY = 1
Валюта.
ASSET_TYPE_COMMODITY = 2
Товар.
ASSET_TYPE_INDEX = 3
Индекс.
ASSET_TYPE_SECURITY = 4
Ценная бумага.
message
instruments.proto:422Объект передачи информации об облигации.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код (секция торгов).
string isin = 4
ISIN-идентификатор инструмента.
int32 lot = 5
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot).
string currency = 6
Валюта расчетов.
optional klong = 7
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 8
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 9
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 10
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 11
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 12
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 13
Признак доступности для операций в шорт.
string name = 15
Название инструмента.
string exchange = 16
Tорговая площадка (секция биржи).
int32 coupon_quantity_per_year = 17
Количество выплат по купонам в год.
optional maturity_date = 18
Дата погашения облигации по UTC.
optional nominal = 19
Номинал облигации.
optional initial_nominal = 20
Первоначальный номинал облигации.
optional state_reg_date = 21
Дата выпуска облигации по UTC.
optional placement_date = 22
Дата размещения по UTC.
optional placement_price = 23
Цена размещения.
optional aci_value = 24
Значение НКД (накопленного купонного дохода) на дату.
string country_of_risk = 25
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 26
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
string sector = 27
Сектор экономики.
string issue_kind = 28
Форма выпуска. Возможные значения: <br/>**documentary** — документарная; <br/>**non_documentary** — бездокументарная.
int64 issue_size = 29
Размер выпуска.
int64 issue_size_plan = 30
Плановый размер выпуска.
SecurityTradingStatus trading_status = 31
Текущий режим торгов инструмента.
bool otc_flag = 32
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 33
Признак доступности для покупки.
bool sell_available_flag = 34
Признак доступности для продажи.
bool floating_coupon_flag = 35
Признак облигации с плавающим купоном.
bool perpetual_flag = 36
Признак бессрочной облигации.
bool amortization_flag = 37
Признак облигации с амортизацией долга.
optional min_price_increment = 38
Шаг цены.
bool api_trade_available_flag = 39
Параметр указывает на возможность торговать инструментом через API.
string uid = 40
Уникальный идентификатор инструмента.
RealExchange real_exchange = 41
Реальная площадка исполнения расчетов. (биржа)
string position_uid = 42
Уникальный идентификатор позиции инструмента.
string asset_uid = 43
Уникальный идентификатор актива.
bool for_iis_flag = 51
Признак доступности для ИИС.
bool for_qual_investor_flag = 52
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 53
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 54
Флаг заблокированного ТКС.
bool subordinated_flag = 55
Признак субординированной облигации.
bool liquidity_flag = 56
Флаг достаточной ликвидности.
optional first_1min_candle_date = 61
Дата первой минутной свечи.
optional first_1day_candle_date = 62
Дата первой дневной свечи.
RiskLevel risk_level = 63
Уровень риска.
optional brand = 64
Информация о бренде.
BondType bond_type = 65
Тип облигации.
optional call_date = 69
Дата погашения облигации.
optional dlong_client = 90
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 91
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
Used in:
BOND_TYPE_UNSPECIFIED = 0
Тип облигации не определен.
BOND_TYPE_REPLACED = 1
Замещающая облигация.
message
instruments.proto:1038Бренд.
Used as response type in: InstrumentsService.GetBrandBy
Used as field type in: ,
string uid = 1
UID-идентификатор бренда.
string name = 2
Наименование бренда.
string description = 3
Описание.
string info = 4
Информация о бренде.
string company = 5
Компания.
string sector = 6
Сектор.
string country_of_risk = 7
Код страны риска.
string country_of_risk_name = 8
Наименование страны риска.
message
common.proto:118Used in: , , , , , ,
string logo_name = 1
Логотип инструмента. Имя файла для получения логотипа.
string logo_base_color = 2
Цвет бренда.
string text_color = 3
Цвет текста для цвета логотипа бренда.
message
operations.proto:258Used in:
string trade_id = 1
Номер сделки.
string order_id = 2
Номер поручения.
string figi = 3
FIGI-идентификаторинструмента.
string execute_sign = 4
Признак исполнения.
optional trade_datetime = 5
Дата и время заключения по UTC.
string exchange = 6
Торговая площадка.
string class_code = 7
Режим торгов.
string direction = 8
Вид сделки.
string name = 9
Сокращенное наименование актива.
string ticker = 10
Код актива.
optional price = 11
Цена за единицу.
int64 quantity = 12
Количество.
optional order_amount = 13
Сумма без НКД.
optional aci_value = 14
НКД.
optional total_order_amount = 15
Сумма сделки.
optional broker_commission = 16
Комиссия брокера.
optional exchange_commission = 17
Комиссия биржи.
optional exchange_clearing_commission = 18
Комиссия клирингового центра.
optional repo_rate = 19
Ставка РЕПО, %.
string party = 20
Контрагент или брокерарокер.
optional clear_value_date = 21
Дата расчетов по UTC.
optional sec_value_date = 22
Дата поставки по UTC.
string broker_status = 23
Статус брокера.
string separate_agreement_type = 24
Тип договора.
string separate_agreement_number = 25
Номер договора.
string separate_agreement_date = 26
Дата договора.
string delivery_type = 27
Тип расчета по сделке.
message
orders.proto:149Запрос отмены торгового поручения.
Used as request type in: OrdersService.CancelOrder, SandboxService.CancelSandboxOrder
string account_id = 1
Номер счета.
string order_id = 2
Идентификатор заявки.
optional OrderIdType order_id_type = 3
Тип идентификатора заявки.
message
orders.proto:156Результат отмены торгового поручения.
Used as response type in: OrdersService.CancelOrder, SandboxService.CancelSandboxOrder
optional time = 1
Дата и время отмены заявки в часовом поясе UTC.
optional response_metadata = 254
Метадата
message
marketdata.proto:288Пакет свечей в рамках стрима.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SubscriptionInterval interval = 2
Интервал свечи.
optional open = 3
Цена открытия за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional high = 4
Максимальная цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional low = 5
Минимальная цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional close = 6
Цена закрытия за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
int64 volume = 7
Объем сделок в лотах.
optional time = 8
Время начала интервала свечи по UTC.
optional last_trade_ts = 9
Время последней сделки, вошедшей в свечу по UTC.
string instrument_uid = 10
UID инструмента.
CandleSource candle_source_type = 19
Источник свечей.
message
marketdata.proto:126Запрос изменения статус подписки на свечи.
Used in:
string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
SubscriptionInterval interval = 2
Интервал свечей. Двухчасовые и четырехчасовые свечи в стриме отсчитываются с 0:00 по UTC.
string instrument_id = 3
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
Интервал свечей. Максимальное значение интервала приведено ориентировочно, может отличаться в большую сторону в зависимости от параметров запроса.
Used in:
CANDLE_INTERVAL_UNSPECIFIED = 0
Интервал не определен.
CANDLE_INTERVAL_1_MIN = 1
От 1 минуты до 1 дня. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_5_MIN = 2
От 5 минут до недели. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_15_MIN = 3
От 15 минут до 3 недель. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_HOUR = 4
От 1 часа до 3 месяцев. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_DAY = 5
От 1 дня до 6 лет. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_2_MIN = 6
От 2 минут до 1 дня. Максимальное значение `limit` — 1200.
CANDLE_INTERVAL_3_MIN = 7
От 3 минут до 1 дня. Максимальное значение `limit` — 750.
CANDLE_INTERVAL_10_MIN = 8
От 10 минут до недели. Максимальное значение `limit` — 1200.
CANDLE_INTERVAL_30_MIN = 9
От 30 минут до 3 недель. Максимальное значение `limit` — 1200.
CANDLE_INTERVAL_2_HOUR = 10
От 2 часов до 3 месяцев. Максимальное значение `limit` — 2400.
CANDLE_INTERVAL_4_HOUR = 11
От 4 часов до 3 месяцев. Максимальное значение `limit` — 700.
CANDLE_INTERVAL_WEEK = 12
От 1 недели до 5 лет. Максимальное значение `limit` — 300.
CANDLE_INTERVAL_MONTH = 13
От 1 месяца до 10 лет. Максимальное значение `limit` — 120.
CANDLE_INTERVAL_5_SEC = 14
От 5 секунд до 200 минут. Максимальное значение `limit` — 2500.
CANDLE_INTERVAL_10_SEC = 15
От 10 секунд до 200 минут. Максимальное значение `limit` — 1250.
CANDLE_INTERVAL_30_SEC = 16
От 30 секунд до 20 часов. Максимальное значение `limit` — 2500.
Used in: ,
CANDLE_SOURCE_UNSPECIFIED = 0
Источник свечей не определен.
CANDLE_SOURCE_EXCHANGE = 1
Биржевые свечи.
CANDLE_SOURCE_DEALER_WEEKEND = 2
Свечи дилера в результате торговли по выходным.
message
marketdata.proto:139Статус подписки на свечи.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SubscriptionInterval interval = 2
Интервал свечей.
SubscriptionStatus subscription_status = 3
Статус подписки.
string instrument_uid = 4
UID инструмента.
bool waiting_close = 5
Флаг ожидания закрытия временного интервала для отправки свечи.
string stream_id = 6
Идентификатор открытого соединения.
string subscription_id = 7
Идентификатор подписки в формате `UUID`.
optional GetCandlesRequest.CandleSource candle_source_type = 9
Источник свечей.
message
operations.proto:577Used in: ,
string instrument_uid = 1
Уникальный идентификатор инструмента.
optional payment = 2
Сумма операции.
message
instruments.proto:1198Данные о стране.
Used in:
string alfa_two = 1
Двухбуквенный код страны.
string alfa_three = 2
Трехбуквенный код страны.
string name = 3
Наименование страны.
string name_brief = 4
Краткое наименование страны.
message
instruments.proto:262Объект передачи информации о купоне облигации.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
optional coupon_date = 2
Дата выплаты купона.
int64 coupon_number = 3
Номер купона.
optional fix_date = 4
Дата фиксации реестра для выплаты купона — опционально.
optional pay_one_bond = 5
Выплата на одну облигацию.
CouponType coupon_type = 6
Тип купона.
optional coupon_start_date = 7
Начало купонного периода.
optional coupon_end_date = 8
Окончание купонного периода.
int32 coupon_period = 9
Купонный период в днях.
Тип купонов.
Used in:
COUPON_TYPE_UNSPECIFIED = 0
Неопределенное значение.
COUPON_TYPE_CONSTANT = 1
Постоянный.
COUPON_TYPE_FLOATING = 2
Плавающий.
COUPON_TYPE_DISCOUNT = 3
Дисконт.
COUPON_TYPE_MORTGAGE = 4
Ипотечный.
COUPON_TYPE_FIX = 5
Фиксированный.
COUPON_TYPE_VARIABLE = 6
Переменный.
COUPON_TYPE_OTHER = 7
Прочее.
message
instruments.proto:491Объект передачи информации о валюте.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код (секция торгов).
string isin = 4
ISIN-идентификатор инструмента.
int32 lot = 5
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot).
string currency = 6
Валюта расчетов.
optional klong = 7
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 8
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 9
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 10
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 11
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 12
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 13
Признак доступности для операций в шорт.
string name = 15
Название инструмента.
string exchange = 16
Tорговая площадка (секция биржи).
optional nominal = 17
Номинал.
string country_of_risk = 18
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 19
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
SecurityTradingStatus trading_status = 20
Текущий режим торгов инструмента.
bool otc_flag = 21
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 22
Признак доступности для покупки.
bool sell_available_flag = 23
Признак доступности для продажи.
string iso_currency_name = 24
Строковый ISO-код валюты.
optional min_price_increment = 25
Шаг цены.
bool api_trade_available_flag = 26
Параметр указывает на возможность торговать инструментом через API.
string uid = 27
Уникальный идентификатор инструмента.
RealExchange real_exchange = 28
Реальная площадка исполнения расчетов (биржа).
string position_uid = 29
Уникальный идентификатор позиции инструмента.
bool for_iis_flag = 41
Признак доступности для ИИС.
bool for_qual_investor_flag = 52
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 53
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 54
Флаг заблокированного ТКС.
optional first_1min_candle_date = 56
Дата первой минутной свечи.
optional first_1day_candle_date = 57
Дата первой дневной свечи.
optional brand = 60
Информация о бренде.
optional dlong_client = 90
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 91
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
message
instruments.proto:821Информация о выплате.
Used in:
optional dividend_net = 1
Величина дивиденда на 1 ценную бумагу (включая валюту).
optional payment_date = 2
Дата фактических выплат по UTC.
optional declared_date = 3
Дата объявления дивидендов по UTC.
optional last_buy_date = 4
Последний день (включительно) покупки для получения выплаты по UTC.
string dividend_type = 5
Тип выплаты. Возможные значения: `Regular Cash` – регулярные выплаты, `Cancelled` – выплата отменена, `Daily Accrual` – ежедневное начисление, `Return of Capital` – возврат капитала, прочие типы выплат.
optional record_date = 6
Дата фиксации реестра по UTC.
string regularity = 7
Регулярность выплаты. Возможные значения: `Annual` – ежегодная, `Semi-Anl` – каждые полгода, прочие типы выплат.
optional close_price = 8
Цена закрытия инструмента на момент `ex_dividend_date`.
optional yield_value = 9
Величина доходности.
optional created_at = 10
Дата и время создания записи по UTC.
message
operations.proto:403Отчет «Справка о доходах за пределами РФ».
Used in:
optional record_date = 1
Дата фиксации реестра.
optional payment_date = 2
Дата выплаты.
string security_name = 3
Наименование ценной бумаги.
string isin = 4
ISIN-идентификатор ценной бумаги.
string issuer_country = 5
Страна эмитента. Для депозитарных расписок указывается страна эмитента базового актива.
int64 quantity = 6
Количество ценных бумаг.
optional dividend = 7
Выплаты на одну бумагу
optional external_commission = 8
Комиссия внешних платежных агентов.
optional dividend_gross = 9
Сумма до удержания налога.
optional tax = 10
Сумма налога, удержанного агентом.
optional dividend_amount = 11
Итоговая сумма выплаты.
string currency = 12
Валюта.
Тип действия со списком избранных инструментов.
Used in:
EDIT_FAVORITES_ACTION_TYPE_UNSPECIFIED = 0
Тип не определен.
EDIT_FAVORITES_ACTION_TYPE_ADD = 1
Добавить в список.
EDIT_FAVORITES_ACTION_TYPE_DEL = 2
Удалить из списка.
message
instruments.proto:1100Массив инструментов для редактирования списка избранных инструментов.
Used in:
optional string figi = 1
FIGI-идентификатор инструмента.
string instrument_id = 2
Идентификатор инструмента — `figi` или `instrument_uid`.
message
common.proto:130Used in:
string code = 1
Код ошибки.
string message = 3
Описание ошибки.
message
instruments.proto:540Объект передачи информации об инвестиционном фонде.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код (секция торгов).
string isin = 4
ISIN-идентификатор инструмента.
int32 lot = 5
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot).
string currency = 6
Валюта расчетов.
optional klong = 7
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 8
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 9
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 10
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 11
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 12
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 13
Признак доступности для операций в шорт.
string name = 15
Название инструмента.
string exchange = 16
Tорговая площадка (секция биржи).
optional fixed_commission = 17
Размер фиксированной комиссии фонда.
string focus_type = 18
Возможные значения: <br/>**equity** — акции;<br/>**fixed_income** — облигации;<br/>**mixed_allocation** — смешанный;<br/>**money_market** — денежный рынок;<br/>**real_estate** — недвижимость;<br/>**commodity** — товары;<br/>**specialty** — специальный;<br/>**private_equity** — private equity;<br/>**alternative_investment** — альтернативные инвестиции.
optional released_date = 19
Дата выпуска по UTC.
optional num_shares = 20
Количество паев фонда в обращении.
string country_of_risk = 21
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 22
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
string sector = 23
Сектор экономики.
string rebalancing_freq = 24
Частота ребалансировки.
SecurityTradingStatus trading_status = 25
Текущий режим торгов инструмента.
bool otc_flag = 26
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 27
Признак доступности для покупки.
bool sell_available_flag = 28
Признак доступности для продажи.
optional min_price_increment = 29
Шаг цены.
bool api_trade_available_flag = 30
Параметр указывает на возможность торговать инструментом через API.
string uid = 31
Уникальный идентификатор инструмента.
RealExchange real_exchange = 32
Реальная площадка исполнения расчетов (биржа).
string position_uid = 33
Уникальный идентификатор позиции инструмента.
string asset_uid = 34
Уникальный идентификатор актива.
InstrumentExchangeType instrument_exchange = 35
Тип площадки торговли.
bool for_iis_flag = 41
Признак доступности для ИИС.
bool for_qual_investor_flag = 42
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 43
ФлагФлаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 44
Флаг заблокированного ТКС.
bool liquidity_flag = 45
Флаг достаточной ликвидности.
optional first_1min_candle_date = 56
Дата первой минутной свечи.
optional first_1day_candle_date = 57
Дата первой дневной свечи.
optional brand = 60
Информация о бренде.
optional dlong_client = 90
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 91
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
Тип выставляемой заявки.
Used in: ,
EXCHANGE_ORDER_TYPE_UNSPECIFIED = 0
Значение не указано.
EXCHANGE_ORDER_TYPE_MARKET = 1
Заявка по рыночной цене.
EXCHANGE_ORDER_TYPE_LIMIT = 2
Лимитная заявка.
message
instruments.proto:1079Массив избранных инструментов.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код инструмента.
string isin = 4
ISIN-идентификатор инструмента.
string instrument_type = 11
Тип инструмента.
string name = 12
Название инструмента.
string uid = 13
Уникальный идентификатор инструмента.
bool otc_flag = 16
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool api_trade_available_flag = 17
Возможность торговать инструментом через API.
InstrumentType instrument_kind = 18
Тип инструмента.
message
instruments.proto:596Объект передачи информации о фьючерсе.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код (секция торгов).
int32 lot = 4
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot).
string currency = 5
Валюта расчетов.
optional klong = 6
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 7
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 8
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 9
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 10
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 11
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 12
Признак доступности для операций шорт.
string name = 13
Название инструмента.
string exchange = 14
Tорговая площадка (секция биржи).
optional first_trade_date = 15
Дата начала обращения контракта по UTC.
optional last_trade_date = 16
Дата по UTC, до которой возможно проведение операций с фьючерсом.
string futures_type = 17
Тип фьючерса. Возможные значения: <br/>**physical_delivery** — физические поставки; <br/>**cash_settlement** — денежный эквивалент.
string asset_type = 18
Тип актива. Возможные значения: <br/>**commodity** — товар; <br/>**currency** — валюта; <br/>**security** — ценная бумага; <br/>**index** — индекс.
string basic_asset = 19
Основной актив.
optional basic_asset_size = 20
Размер основного актива.
string country_of_risk = 21
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 22
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
string sector = 23
Сектор экономики.
optional expiration_date = 24
Дата истечения срока в часов поясе UTC.
SecurityTradingStatus trading_status = 25
Текущий режим торгов инструмента.
bool otc_flag = 26
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 27
Признак доступности для покупки.
bool sell_available_flag = 28
Признак доступности для продажи.
optional min_price_increment = 29
Шаг цены.
bool api_trade_available_flag = 30
Параметр указывает на возможность торговать инструментом через API.
string uid = 31
Уникальный идентификатор инструмента.
RealExchange real_exchange = 32
Реальная площадка исполнения расчетов (биржа).
string position_uid = 33
Уникальный идентификатор позиции инструмента.
string basic_asset_position_uid = 34
Уникальный идентификатор позиции основного инструмента.
bool for_iis_flag = 41
Признак доступности для ИИС.
bool for_qual_investor_flag = 42
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 43
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 44
Флаг заблокированного ТКС.
optional first_1min_candle_date = 56
Дата первой минутной свечи.
optional first_1day_candle_date = 57
Дата первой дневной свечи.
optional initial_margin_on_buy = 61
Гарантийное обеспечение при покупке.
optional initial_margin_on_sell = 62
Гарантийное обеспечение при продаже.
optional min_price_increment_amount = 63
Стоимость шага цены.
optional brand = 64
Информация о бренде.
optional dlong_client = 90
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 91
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
message
operations.proto:236Used in:
string account_id = 1
Идентификатор счета клиента.
optional from = 2
Начало периода по UTC.
optional to = 3
Окончание периода по UTC.
message
operations.proto:242Used in:
string task_id = 1
Идентификатор задачи формирования брокерского отчета.
message
operations.proto:378Объект запроса формирования отчета «Справка о доходах за пределами РФ».
Used in:
string account_id = 1
Идентификатор счета клиента.
optional from = 2
Начало периода по UTC.
optional to = 3
Окончание периода по UTC. Как правило, можно сформировать отчет по дату на несколько дней меньше текущей. Начало и окончание периода должны быть в рамках одного календарного года.
message
operations.proto:391Объект результата задачи запуска формирования отчета «Справка о доходах за пределами РФ».
Used in:
string task_id = 1
Идентификатор задачи формирования отчета.
message
users.proto:37Запрос получения счетов пользователя.
Used as request type in: SandboxService.GetSandboxAccounts, UsersService.GetAccounts
optional AccountStatus status = 1
Статус счета.
message
users.proto:42Список счетов пользователя.
Used as response type in: SandboxService.GetSandboxAccounts, UsersService.GetAccounts
repeated accounts = 1
Массив счетов клиента.
message
instruments.proto:1264Фундаментальные показатели по активу
Used in:
string asset_uid = 1
Идентификатор актива.
string currency = 2
Валюта.
double market_capitalization = 3
Рыночная капитализация.
double high_price_last_52_weeks = 4
Максимум за год.
double low_price_last_52_weeks = 5
Минимум за год.
double average_daily_volume_last_10_days = 6
Средний объем торгов за 10 дней.
double average_daily_volume_last_4_weeks = 7
Средний объем торгов за месяц.
double beta = 8
double free_float = 9
Доля акций в свободном обращении.
double forward_annual_dividend_yield = 10
Процент форвардной дивидендной доходности по отношению к цене акций.
double shares_outstanding = 11
Количество акций в обращении.
double revenue_ttm = 12
Выручка.
double ebitda_ttm = 13
EBITDA — прибыль до вычета процентов, налогов, износа и амортизации.
double net_income_ttm = 14
Чистая прибыль.
double eps_ttm = 15
EPS — величина чистой прибыли компании, которая приходится на каждую обыкновенную акцию.
double diluted_eps_ttm = 16
EPS компании с допущением, что все конвертируемые ценные бумаги компании были сконвертированы в обыкновенные акции.
double free_cash_flow_ttm = 17
Свободный денежный поток.
double five_year_annual_revenue_growth_rate = 18
Среднегодовой рocт выручки за 5 лет.
double three_year_annual_revenue_growth_rate = 19
Среднегодовой рocт выручки за 3 года.
double pe_ratio_ttm = 20
Соотношение рыночной капитализации компании к ее чистой прибыли.
double price_to_sales_ttm = 21
Соотношение рыночной капитализации компании к ее выручке.
double price_to_book_ttm = 22
Соотношение рыночной капитализации компании к ее балансовой стоимости.
double price_to_free_cash_flow_ttm = 23
Соотношение рыночной капитализации компании к ее свободному денежному потоку.
double total_enterprise_value_mrq = 24
Рыночная стоимость компании.
double ev_to_ebitda_mrq = 25
Соотношение EV и EBITDA.
double net_margin_mrq = 26
Маржа чистой прибыли.
double net_interest_margin_mrq = 27
Рентабельность чистой прибыли.
double roe = 28
Рентабельность собственного капитала.
double roa = 29
Рентабельность активов.
double roic = 30
Рентабельность активов.
double total_debt_mrq = 31
Сумма краткосрочных и долгосрочных обязательств компании.
double total_debt_to_equity_mrq = 32
Соотношение долга к собственному капиталу.
double total_debt_to_ebitda_mrq = 33
Total Debt/EBITDA.
double free_cash_flow_to_price = 34
Отношение свободногоо кэша к стоимости.
double net_debt_to_ebitda = 35
Отношение чистого долга к EBITDA.
double current_ratio_mrq = 36
Коэффициент текущей ликвидности.
double fixed_charge_coverage_ratio_fy = 37
Коэффициент покрытия фиксированных платежей — FCCR.
double dividend_yield_daily_ttm = 38
Дивидендная доходность за 12 месяцев.
double dividend_rate_ttm = 39
Выплаченные дивиденды за 12 месяцев.
double dividends_per_share = 40
Значение дивидендов на акцию.
double five_years_average_dividend_yield = 41
Средняя дивидендная доходность за 5 лет.
double five_year_annual_dividend_growth_rate = 42
Среднегодовой рост дивидендов за 5 лет.
double dividend_payout_ratio_fy = 43
Процент чистой прибыли, уходящий на выплату дивидендов.
double buy_back_ttm = 44
Деньги, потраченные на обратный выкуп акций.
double one_year_annual_revenue_growth_rate = 45
Рост выручки за 1 год.
string domicile_indicator_code = 46
Код страны.
double adr_to_common_share_ratio = 47
Соотношение депозитарной расписки к акциям.
double number_of_employees = 48
Количество сотрудников.
optional ex_dividend_date = 49
optional fiscal_period_start_date = 50
Начало фискального периода.
optional fiscal_period_end_date = 51
Окончание фискального периода.
double revenue_change_five_years = 53
Изменение общего дохода за 5 лет.
double eps_change_five_years = 54
Изменение EPS за 5 лет.
double ebitda_change_five_years = 55
Изменение EBIDTA за 5 лет.
double total_debt_change_five_years = 56
Изменение общей задолжности за 5 лет.
double ev_to_sales = 57
Отношение EV к выручке.
Used in:
PERIOD_TYPE_UNSPECIFIED = 0
Не указан.
PERIOD_TYPE_QUARTER = 1
Квартальный.
PERIOD_TYPE_SEMIANNUAL = 2
Полугодовой.
PERIOD_TYPE_ANNUAL = 3
Годовой.
message
instruments.proto:1337Отчет
Used in:
string instrument_id = 1
Идентификатор инструмента.
optional report_date = 2
Дата публикации отчета.
int32 period_year = 3
Год периода отчета.
int32 period_num = 4
Номер периода.
AssetReportPeriodType period_type = 5
Тип отчета.
optional created_at = 6
Дата создания записи.
Used in: ,
EVENT_TYPE_UNSPECIFIED = 0
Неопределенное значение.
EVENT_TYPE_CPN = 1
Купон.
EVENT_TYPE_CALL = 2
Опцион (оферта).
EVENT_TYPE_MTY = 3
Погашение.
EVENT_TYPE_CONV = 4
Конвертация.
message
instruments.proto:234Used in:
string instrument_id = 2
Идентификатор инструмента.
int32 event_number = 3
Номер события для данного типа события.
optional event_date = 4
Дата события.
GetBondEventsRequest.EventType event_type = 5
Тип события.
optional event_total_vol = 6
Полное количество бумаг, задействованных в событии.
optional fix_date = 7
Дата фиксации владельцев для участия в событии.
optional rate_date = 8
Дата определения даты или факта события.
optional default_date = 9
Дата дефолта, если применимо.
optional real_pay_date = 10
Дата реального исполнения обязательства.
optional pay_date = 11
Дата выплаты.
optional pay_one_bond = 12
Выплата на одну облигацию.
optional money_flow_val = 13
Выплаты на все бумаги, задействованные в событии.
string execution = 14
Признак исполнения.
string operation_type = 15
Тип операции.
optional value = 16
Стоимость операции — ставка купона, доля номинала, цена выкупа или коэффициент конвертации.
string note = 17
Примечание.
string convert_to_fin_tool_id = 18
ID выпуска бумаг, в который произведена конвертация (для конвертаций).
optional coupon_start_date = 19
Начало купонного периода.
optional coupon_end_date = 20
Окончание купонного периода.
int32 coupon_period = 21
Купонный период.
optional coupon_interest_rate = 22
Ставка купона, процентов годовых.
message
operations.proto:246Used in:
string task_id = 1
Идентификатор задачи формирования брокерского отчета.
optional int32 page = 2
Номер страницы отчета, начинается с 1. Значение по умолчанию — 0.
message
operations.proto:251Used in:
repeated broker_report = 1
int32 itemsCount = 2
Количество записей в отчете.
int32 pagesCount = 3
Количество страниц с данными отчета, начинается с 0.
int32 page = 4
Текущая страница, начинается с 0.
Used in: , ,
CANDLE_SOURCE_UNSPECIFIED = 0
Все свечи.
CANDLE_SOURCE_EXCHANGE = 1
Биржевые свечи.
CANDLE_SOURCE_INCLUDE_WEEKEND = 3
Все свечи с учетом торговли по выходным.
message
instruments.proto:1365Прогноз
Used in:
string uid = 1
UID-идентификатор.
string asset_uid = 2
UID-идентификатор актива.
optional created_at = 3
Дата и время создания записи.
optional best_target_price = 4
Целевая цена на 12 месяцев.
optional best_target_low = 5
Минимальная прогнозная цена.
optional best_target_high = 6
Максимальная прогнозная цена.
int32 total_buy_recommend = 7
Количество аналитиков рекомендующих покупать.
int32 total_hold_recommend = 8
Количество аналитиков рекомендующих держать.
int32 total_sell_recommend = 9
Количество аналитиков рекомендующих продавать.
string currency = 10
Валюта прогнозов инструмента.
Recommendation consensus = 11
Консенсус-прогноз.
optional prognosis_date = 12
Дата прогноза.
message
operations.proto:385Объект запроса сформированного отчета «Справка о доходах за пределами РФ».
Used in:
string task_id = 1
Идентификатор задачи формирования отчета.
optional int32 page = 2
Номер страницы отчета (начинается с 0), значение по умолчанию: 0.
message
operations.proto:395Used in:
repeated dividends_foreign_issuer_report = 1
int32 itemsCount = 2
Количество записей в отчете.
int32 pagesCount = 3
Количество страниц с данными отчета, начинается с 0.
int32 page = 4
Текущая страница, начинается с 0.
message
instruments.proto:1149Избранная группа
Used in:
string group_id = 1
Уникальный идентификатор группы.
string group_name = 2
Название группы.
string color = 3
Цвет группы в HEX-формате.
int32 size = 4
Количество инструментов в группе.
optional bool contains_instrument = 5
Признак наличия в группе хотя бы одного инструмента из запроса.
message
instruments.proto:1415Консенсус-прогноз.
Used in:
string uid = 1
Уникальный идентификатор инструмента.
string ticker = 2
Тикер инструмента.
Recommendation recommendation = 3
Прогноз.
string currency = 4
Валюта.
optional current_price = 5
Текущая цена.
optional consensus = 6
Прогнозируемая цена.
optional min_target = 7
Минимальная цена прогноза.
optional max_target = 8
Максимальная цена прогноза.
optional price_change = 9
Изменение цены.
optional price_change_rel = 10
Относительное изменение цены.
message
instruments.proto:1400Прогноз
Used in:
string uid = 1
Уникальный идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string company = 3
Название компании, давшей прогноз.
Recommendation recommendation = 4
Прогноз.
optional recommendation_date = 5
Дата прогноза.
string currency = 6
Валюта.
optional current_price = 7
Текущая цена.
optional target_price = 8
Прогнозируемая цена.
optional price_change = 9
Изменение цены.
optional price_change_rel = 10
Относительное изменение цены.
string show_name = 11
Наименование инструмента.
message
orders.proto:222Запрос на расчет количества доступных для покупки/продажи лотов. Если не указывать цену инструмента, то расчет произведется по текущум ценам в стакане: по лучшему предложению для покупки и по лучшему спросу для продажи.
Used as request type in: OrdersService.GetMaxLots, SandboxService.GetSandboxMaxLots
string account_id = 1
Номер счета
string instrument_id = 2
Идентификатор инструмента, принимает значения Figi или instrument_uid
optional price = 3
Цена инструмента
message
orders.proto:229Результат количество доступных для покупки/продажи лотов
Used as response type in: OrdersService.GetMaxLots, SandboxService.GetSandboxMaxLots
string currency = 1
Валюта инструмента
optional buy_limits = 2
Лимиты для покупок на собственные деньги
optional buy_margin_limits = 3
Лимиты для покупок с учетом маржинального кредитования
optional sell_limits = 4
Лимиты для продаж по собственной позиции
optional sell_margin_limits = 5
Лимиты для продаж с учетом маржинального кредитования
message
orders.proto:236Used in:
optional buy_money_amount = 1
Количество доступной валюты для покупки
int64 buy_max_lots = 2
Максимальное доступное количество лотов для покупки
int64 buy_max_market_lots = 3
Максимальное доступное количество лотов для покупки для заявки по рыночной цене на текущий момент
message
orders.proto:242Used in:
int64 sell_max_lots = 1
Максимальное доступное количество лотов для продажи
message
marketdata.proto:500Запрос активных подписок. Возвращает по одному сообщению на каждый тип активных подписок — `SubscribeLastPriceResponse`, `SubscribeInfoResponse`, `SubscribeTradesResponse`, `SubscribeOrderBookResponse`, `SubscribeCandlesResponse`.
Used in:
(message has no fields)
message
operations.proto:455Запрос списка операций по счету с пагинацией.
Used as request type in: OperationsService.GetOperationsByCursor, SandboxService.GetSandboxOperationsByCursor
string account_id = 1
Идентификатор счета клиента, обязательный параметр. Остальные параметры опциональны.
optional string instrument_id = 2
Идентификатор инструмента — FIGI или UID инструмента.
optional from = 6
Начало периода по UTC.
optional to = 7
Окончание периода по UTC.
optional string cursor = 11
Идентификатор элемента, с которого начать формировать ответ.
optional int32 limit = 12
Лимит количества операций. По умолчанию — `100`, максимальное значение — `1000`.
repeated OperationType operation_types = 13
Тип операции. Принимает значение из списка `OperationType`.
optional OperationState state = 14
Статус запрашиваемых операций. Возможные значения указаны в `OperationState`.
optional bool without_commissions = 15
Флаг возврата комиссии. По умолчанию — `false`.
optional bool without_trades = 16
Флаг получения ответа без массива сделок.
optional bool without_overnights = 17
Флаг показа overnight операций.
message
operations.proto:470Список операций по счету с пагинацией.
Used as response type in: OperationsService.GetOperationsByCursor, SandboxService.GetSandboxOperationsByCursor
bool has_next = 1
Признак, есть ли следующий элемент.
string next_cursor = 2
Следующий курсор.
repeated items = 6
Список операций.
message
orders.proto:271Used in:
optional aci_value = 2
Значение НКД (накопленного купонного дохода) на дату
optional nominal_conversion_rate = 3
Курс конвертации для замещающих облигаций
message
orders.proto:276Used in:
optional initial_margin = 2
Гарантийное обеспечение для фьючерса
message
orders.proto:162Запрос получения статуса торгового поручения.
Used as request type in: OrdersService.GetOrderState, SandboxService.GetSandboxOrderState
string account_id = 1
Номер счета.
string order_id = 2
Идентификатор заявки.
PriceType price_type = 3
Тип цены.
optional OrderIdType order_id_type = 4
Тип идентификатора заявки.
message
orders.proto:170Запрос получения списка активных торговых поручений.
Used as request type in: OrdersService.GetOrders, SandboxService.GetSandboxOrders
string account_id = 1
Номер счета.
message
orders.proto:175Список активных торговых поручений.
Used as response type in: OrdersService.GetOrders, SandboxService.GetSandboxOrders
repeated orders = 1
Массив активных заявок.
message
marketdata.proto:544Used in:
optional deviation_multiplier = 1
Количество стандартных отклонений, на которые отступают верхняя и нижняя границы.
Интервал свечи.
Used in:
INDICATOR_INTERVAL_UNSPECIFIED = 0
Интервал не определен.
INDICATOR_INTERVAL_ONE_MINUTE = 1
1 минута.
INDICATOR_INTERVAL_FIVE_MINUTES = 2
5 минут.
INDICATOR_INTERVAL_FIFTEEN_MINUTES = 3
15 минут.
INDICATOR_INTERVAL_ONE_HOUR = 4
1 час.
INDICATOR_INTERVAL_ONE_DAY = 5
1 день.
INDICATOR_INTERVAL_2_MIN = 6
2 минуты.
INDICATOR_INTERVAL_3_MIN = 7
3 минуты.
INDICATOR_INTERVAL_10_MIN = 8
10 минут.
INDICATOR_INTERVAL_30_MIN = 9
30 минут.
INDICATOR_INTERVAL_2_HOUR = 10
2 часа.
INDICATOR_INTERVAL_4_HOUR = 11
4 часа.
INDICATOR_INTERVAL_WEEK = 12
Неделя.
INDICATOR_INTERVAL_MONTH = 13
Месяц.
Used in:
INDICATOR_TYPE_UNSPECIFIED = 0
Не определен.
INDICATOR_TYPE_BB = 1
Bollinger Bands — линия Боллинжера.
INDICATOR_TYPE_EMA = 2
Exponential Moving Average — EMA, экспоненциальная скользящая средняя.
INDICATOR_TYPE_RSI = 3
Relative Strength Index — индекс относительной силы.
INDICATOR_TYPE_MACD = 4
Moving Average Convergence/Divergence — схождение/расхождение скользящих средних.
INDICATOR_TYPE_SMA = 5
Simple Moving Average — простое скользящее среднее.
message
marketdata.proto:538Used in:
int32 fast_length = 1
Короткий период сглаживания для первой экспоненциальной скользящей средней (EMA).
int32 slow_length = 2
Длинный период сглаживания для второй экспоненциальной скользящей средней (EMA).
int32 signal_smoothing = 3
Период сглаживания для третьей экспоненциальной скользящей средней (EMA)
Used in:
TYPE_OF_PRICE_UNSPECIFIED = 0
Не указано.
TYPE_OF_PRICE_CLOSE = 1
Цена закрытия.
TYPE_OF_PRICE_OPEN = 2
Цена открытия.
TYPE_OF_PRICE_HIGH = 3
Максимальное значение за выбранный интервал.
TYPE_OF_PRICE_LOW = 4
Минимальное значение за выбранный интервал.
TYPE_OF_PRICE_AVG = 5
Среднее значение по показателям [ (close + open + high + low) / 4 ].
message
marketdata.proto:588Used in:
optional timestamp = 1
Временная метка по UTC, для которой были рассчитаны значения индикатора.
optional middle_band = 2
Значение простого скользящего среднего (средней линии).
optional upper_band = 3
Значение верхней линии Боллинджера.
optional lower_band = 4
Значение нижней линии Боллинджера.
optional signal = 5
Значение сигнальной линии.
optional macd = 6
Значение линии MACD.
message
marketdata.proto:473Информация о торговом статусе.
Used as response type in: MarketDataService.GetTradingStatus
Used as field type in:
string figi = 1
FIGI-идентификатор инструмента.
SecurityTradingStatus trading_status = 2
Статус торговли инструментом.
bool limit_order_available_flag = 3
Признак доступности выставления лимитной заявки по инструменту.
bool market_order_available_flag = 4
Признак доступности выставления рыночной заявки по инструменту.
bool api_trade_available_flag = 5
Признак доступности торгов через API.
string instrument_uid = 6
UID инструмента.
bool bestprice_order_available_flag = 8
Признак доступности завяки по лучшей цене.
bool only_best_price = 9
Признак доступности только заявки по лучшей цене.
message
marketdata.proto:400Информация о свече.
Used in:
optional open = 1
Цена открытия за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional high = 2
Максимальная цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional low = 3
Минимальная цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional close = 4
Цена закрытия за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
int64 volume = 5
Объем торгов в лотах.
optional time = 6
Время свечи в часовом поясе UTC.
bool is_complete = 7
Признак завершенности свечи. **false** — свеча за текущие интервал еще сформирована не полностью.
CandleSource candle_source = 9
Тип источника свечи
message
instruments.proto:1184Индикатив
Used in:
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код инструмента.
string currency = 4
Валюта расчетов.
InstrumentType instrument_kind = 10
Тип инструмента.
string name = 12
Название инструмента.
string exchange = 13
Tорговая площадка (секция биржи).
string uid = 14
Уникальный идентификатор инструмента.
bool buy_available_flag = 404
Признак доступности для покупки.
bool sell_available_flag = 405
Признак доступности для продажи.
message
marketdata.proto:240Запрос подписки на торговый статус.
Used in:
string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`.
string instrument_id = 2
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
message
marketdata.proto:252Статус подписки.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SubscriptionStatus subscription_status = 2
Статус подписки.
string instrument_uid = 3
UID инструмента.
string stream_id = 4
Идентификатор открытого соединения.
string subscription_id = 5
Идентификатор подписки в формате UUID.
message
instruments.proto:759Объект передачи основной информации об инструменте.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код инструмента.
string isin = 4
ISIN-идентификатор инструмента.
int32 lot = 5
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot).
string currency = 6
Валюта расчетов.
optional klong = 7
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 8
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 9
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 10
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 11
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 12
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 13
Признак доступности для операций в шорт.
string name = 14
Название инструмента.
string exchange = 15
Tорговая площадка (секция биржи).
string country_of_risk = 16
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 17
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
string instrument_type = 18
Тип инструмента.
SecurityTradingStatus trading_status = 19
Текущий режим торгов инструмента.
bool otc_flag = 20
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 21
Признак доступности для покупки.
bool sell_available_flag = 22
Признак доступности для продажи.
optional min_price_increment = 23
Шаг цены.
bool api_trade_available_flag = 24
Параметр указывает на возможность торговать инструментом через API.
string uid = 25
Уникальный идентификатор инструмента.
RealExchange real_exchange = 26
Реальная площадка исполнения расчетов (биржа).
string position_uid = 27
Уникальный идентификатор позиции инструмента.
string asset_uid = 28
Уникальный идентификатор актива.
bool for_iis_flag = 36
Признак доступности для ИИС.
bool for_qual_investor_flag = 37
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 38
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 39
Флаг заблокированного ТКС.
InstrumentType instrument_kind = 40
Тип инструмента.
optional first_1min_candle_date = 56
Дата первой минутной свечи.
optional first_1day_candle_date = 57
Дата первой дневной свечи.
optional brand = 60
Информация о бренде.
optional dlong_client = 490
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 491
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
message
marketdata.proto:509Запрос цен закрытия торговой сессии по инструменту.
Used in:
string instrument_id = 1
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
message
marketdata.proto:519Цена закрытия торговой сессии по инструменту.
Used in:
string figi = 1
FIGI инструмента.
string instrument_uid = 2
UID инструмента.
optional price = 11
Цена закрытия торговой сессии.
optional evening_session_price = 12
Цена последней сделки с вечерней сессии. Цена публикуется биржей по торговым дням и в нерабочие дни не обновляется.
optional time = 21
Дата совершения торгов.
Площадка торговли.
Used in: , ,
INSTRUMENT_EXCHANGE_UNSPECIFIED = 0
Площадка торговли не определена.
INSTRUMENT_EXCHANGE_DEALER = 1
Бумага, торгуемая у дилера.
Тип идентификатора инструмента. [Подробнее об идентификации инструментов](./faq_identification/).
Used in:
INSTRUMENT_ID_UNSPECIFIED = 0
Значение не определено.
INSTRUMENT_ID_TYPE_FIGI = 1
FIGI.
INSTRUMENT_ID_TYPE_TICKER = 2
Ticker.
INSTRUMENT_ID_TYPE_UID = 3
Уникальный идентификатор.
INSTRUMENT_ID_TYPE_POSITION_UID = 4
Идентификатор позиции.
message
instruments.proto:1062Связь с другим инструментом.
Used in:
string type = 1
Тип связи.
string instrument_uid = 2
UID-идентификатор связанного инструмента.
message
instruments.proto:175Запрос получения инструмента по идентификатору.
Used as request type in: InstrumentsService.BondBy, InstrumentsService.CurrencyBy, InstrumentsService.EtfBy, InstrumentsService.FutureBy, InstrumentsService.GetInstrumentBy, InstrumentsService.OptionBy, InstrumentsService.ShareBy
InstrumentIdType id_type = 1
Тип идентификатора инструмента. Возможные значения — `figi`, `ticker`. [Подробнее об идентификации инструментов](./faq_identification/).
optional string class_code = 2
Идентификатор `class_code`. Обязательный, если `id_type = ticker`.
string id = 3
Идентификатор запрашиваемого инструмента.
message
instruments.proto:1218Краткая информация об инструменте.
Used in:
string isin = 1
ISIN инструмента.
string figi = 2
FIGI инструмента.
string ticker = 3
Ticker инструмента.
string class_code = 4
ClassCode инструмента.
string instrument_type = 5
Тип инструмента.
string name = 6
Название инструмента.
string uid = 7
Уникальный идентификатор инструмента.
string position_uid = 8
Уникальный идентификатор позиции инструмента.
InstrumentType instrument_kind = 10
Тип инструмента.
bool api_trade_available_flag = 11
Возможность торговать инструментом через API.
bool for_iis_flag = 12
Признак доступности для ИИС.
optional first_1min_candle_date = 26
Дата первой минутной свечи.
optional first_1day_candle_date = 27
Дата первой дневной свечи.
bool for_qual_investor_flag = 28
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 29
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 30
Флаг заблокированного ТКС.
int32 lot = 31
Количество бумаг в лоте.
Статус запрашиваемых инструментов.
Used in: , , ,
INSTRUMENT_STATUS_UNSPECIFIED = 0
Значение не определено.
INSTRUMENT_STATUS_BASE = 1
По умолчанию — базовый список инструментов, которыми можно торговать через T-Invest API. Сейчас списки доступных бумаг в API и других интерфейсах совпадают — кроме внебиржевых бумаг, но в будущем списки могут различаться.
INSTRUMENT_STATUS_ALL = 2
Список всех инструментов.
Тип инструмента.
Used in: , , , , , , , ,
INSTRUMENT_TYPE_UNSPECIFIED = 0
INSTRUMENT_TYPE_BOND = 1
Облигация.
INSTRUMENT_TYPE_SHARE = 2
Акция.
INSTRUMENT_TYPE_CURRENCY = 3
Валюта.
INSTRUMENT_TYPE_ETF = 4
Exchange-traded fund. Фонд.
INSTRUMENT_TYPE_FUTURES = 5
Фьючерс.
INSTRUMENT_TYPE_SP = 6
Структурная нота.
INSTRUMENT_TYPE_OPTION = 7
Опцион.
INSTRUMENT_TYPE_CLEARING_CERTIFICATE = 8
Clearing certificate.
INSTRUMENT_TYPE_INDEX = 9
Индекс.
INSTRUMENT_TYPE_COMMODITY = 10
Товар.
message
instruments.proto:182Запрос получения инструментов.
Used as request type in: InstrumentsService.Bonds, InstrumentsService.Currencies, InstrumentsService.Etfs, InstrumentsService.Futures, InstrumentsService.Options, InstrumentsService.Shares
optional InstrumentStatus instrument_status = 1
Статус запрашиваемых инструментов. [Возможные значения](#instrumentstatus).
optional InstrumentExchangeType instrument_exchange = 2
Тип площадки торговли. [Возможные значения](#instrumentexchangetype).
message
marketdata.proto:425Информация о цене последней сделки.
Used in: ,
string figi = 1
FIGI инструмента.
optional price = 2
Цена последней сделки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional time = 3
Время получения последней цены в часовом поясе UTC по времени биржи.
string instrument_uid = 11
UID инструмента.
LastPriceType last_price_type = 12
Тип последней цены.
message
marketdata.proto:267Запрос подписки на последнюю цену.
Used in:
string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`.
string instrument_id = 2
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
message
marketdata.proto:279Статус подписки на цену последней сделки.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SubscriptionStatus subscription_status = 2
Статус подписки.
string instrument_uid = 3
UID инструмента.
string stream_id = 4
Идентификатор открытого соединения.
string subscription_id = 5
Идентификатор подписки в формате `UUID`.
Тип последней цены
Used in: ,
LAST_PRICE_UNSPECIFIED = 0
Не определен.
LAST_PRICE_EXCHANGE = 1
Цена биржи.
LAST_PRICE_DEALER = 2
Цена дилера
message
marketdata.proto:76Пакет биржевой информации по подписке.
Used as response type in: MarketDataStreamService.MarketDataServerSideStream, MarketDataStreamService.MarketDataStream
oneof payload
subscribe_candles_response = 1
Результат подписки на свечи.
subscribe_order_book_response = 2
Результат подписки на стаканы.
subscribe_trades_response = 3
Результат подписки на поток обезличенных сделок.
subscribe_info_response = 4
Результат подписки на торговые статусы инструментов.
candle = 5
Свеча.
trade = 6
Сделки.
orderbook = 7
Стакан.
trading_status = 8
Торговый статус.
ping = 9
Проверка активности стрима.
subscribe_last_price_response = 10
Результат подписки на цены последние сделок по инструментам.
last_price = 11
Цена последней сделки.
message
common.proto:37Денежная сумма в определенной валюте.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string currency = 1
Строковый ISO-код валюты.
int64 units = 2
Целая часть суммы, может быть отрицательным числом.
int32 nano = 3
Дробная часть суммы, может быть отрицательным числом.
message
operations.proto:66Данные по операции.
Used in:
string id = 1
Идентификатор операции.
string parent_operation_id = 2
Идентификатор родительской операции.
string currency = 3
Валюта операции.
optional payment = 4
Сумма операции.
optional price = 5
Цена операции за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
OperationState state = 6
Статус операции.
int64 quantity = 7
Количество единиц инструмента.
int64 quantity_rest = 8
Неисполненный остаток по сделке.
string figi = 9
FIGI-идентификатор инструмента, связанного с операцией.
string instrument_type = 10
Тип инструмента. Возможные значения: <br/><br/>`bond` — облигация; <br/>`share` — акция; <br/>`currency` — валюта; <br/>`etf` — фонд; <br/>`futures` — фьючерс.
optional date = 11
Дата и время операции в формате часовом поясе UTC.
string type = 12
Текстовое описание типа операции.
OperationType operation_type = 13
Тип операции.
repeated trades = 14
Массив сделок.
string asset_uid = 16
Идентификатор актива
string position_uid = 17
Уникальный идентификатор позиции.
string instrument_uid = 18
Уникальный идентификатор инструмента.
repeated child_operations = 19
Массив дочерних операций.
message
operations.proto:477Данные об операции.
Used in:
string cursor = 1
Курсор.
string broker_account_id = 6
Номер счета клиента.
string id = 16
Идентификатор операции, может меняться с течением времени.
string parent_operation_id = 17
Идентификатор родительской операции. Может измениться, если изменился ID родительской операции.
string name = 18
Название операции.
optional date = 21
Дата поручения.
OperationType type = 22
Тип операции.
string description = 23
Описание операции.
OperationState state = 24
Статус поручения.
string instrument_uid = 31
Уникальный идентификатор инструмента.
string figi = 32
FIGI.
string instrument_type = 33
Тип инструмента.
InstrumentType instrument_kind = 34
Тип инструмента.
string position_uid = 35
Уникальный идентификатор позиции.
optional payment = 41
Сумма операции.
optional price = 42
Цена операции за 1 инструмент.
optional commission = 43
Комиссия.
optional yield = 44
Доходность.
optional yield_relative = 45
Относительная доходность.
optional accrued_int = 46
Накопленный купонный доход.
int64 quantity = 51
Количество единиц инструмента.
int64 quantity_rest = 52
Неисполненный остаток по сделке.
int64 quantity_done = 53
Исполненный остаток.
optional cancel_date_time = 56
Дата и время снятия заявки.
string cancel_reason = 57
Причина отмены операции.
optional trades_info = 61
Массив сделок.
string asset_uid = 64
Идентификатор актива.
repeated child_operations = 65
Массив дочерних операций.
message
operations.proto:514Сделка по операции.
Used in:
string num = 1
Номер сделки.
optional date = 6
Дата сделки.
int64 quantity = 11
Количество в единицах.
optional price = 16
Цена.
optional yield = 21
Доходность.
optional yield_relative = 22
Относительная доходность.
message
operations.proto:509Массив с информацией о сделках.
Used in:
repeated trades = 6
Статус запрашиваемых операций.
Used in: , , ,
OPERATION_STATE_UNSPECIFIED = 0
Статус операции не определен.
OPERATION_STATE_EXECUTED = 1
Исполнена частично или полностью.
OPERATION_STATE_CANCELED = 2
Отменена.
OPERATION_STATE_PROGRESS = 3
Исполняется.
message
operations.proto:88Сделка по операции.
Used in:
string trade_id = 1
Идентификатор сделки.
optional date_time = 2
Дата и время сделки по UTC.
int64 quantity = 3
Количество инструментов.
optional price = 4
Цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
Тип операции.
Used in: , ,
OPERATION_TYPE_UNSPECIFIED = 0
Тип операции не определен.
OPERATION_TYPE_INPUT = 1
Пополнение брокерского счета.
OPERATION_TYPE_BOND_TAX = 2
Удержание НДФЛ по купонам.
OPERATION_TYPE_OUTPUT_SECURITIES = 3
Вывод ЦБ.
OPERATION_TYPE_OVERNIGHT = 4
Доход по сделке РЕПО овернайт.
OPERATION_TYPE_TAX = 5
Удержание налога.
OPERATION_TYPE_BOND_REPAYMENT_FULL = 6
Полное погашение облигаций.
OPERATION_TYPE_SELL_CARD = 7
Продажа ЦБ с карты.
OPERATION_TYPE_DIVIDEND_TAX = 8
Удержание налога по дивидендам.
OPERATION_TYPE_OUTPUT = 9
Вывод денежных средств.
OPERATION_TYPE_BOND_REPAYMENT = 10
Частичное погашение облигаций.
OPERATION_TYPE_TAX_CORRECTION = 11
Корректировка налога.
OPERATION_TYPE_SERVICE_FEE = 12
Удержание комиссии за обслуживание брокерского счета.
OPERATION_TYPE_BENEFIT_TAX = 13
Удержание налога за материальную выгоду.
OPERATION_TYPE_MARGIN_FEE = 14
Удержание комиссии за непокрытую позицию.
OPERATION_TYPE_BUY = 15
Покупка ЦБ.
OPERATION_TYPE_BUY_CARD = 16
Покупка ЦБ с карты.
OPERATION_TYPE_INPUT_SECURITIES = 17
Перевод ценных бумаг из другого депозитария.
OPERATION_TYPE_SELL_MARGIN = 18
Продажа в результате Margin-call.
OPERATION_TYPE_BROKER_FEE = 19
Удержание комиссии за операцию.
OPERATION_TYPE_BUY_MARGIN = 20
Покупка в результате Margin-call.
OPERATION_TYPE_DIVIDEND = 21
Выплата дивидендов.
OPERATION_TYPE_SELL = 22
Продажа ЦБ.
OPERATION_TYPE_COUPON = 23
Выплата купонов.
OPERATION_TYPE_SUCCESS_FEE = 24
Удержание комиссии SuccessFee.
OPERATION_TYPE_DIVIDEND_TRANSFER = 25
Передача дивидендного дохода.
OPERATION_TYPE_ACCRUING_VARMARGIN = 26
Зачисление вариационной маржи.
OPERATION_TYPE_WRITING_OFF_VARMARGIN = 27
Списание вариационной маржи.
OPERATION_TYPE_DELIVERY_BUY = 28
Покупка в рамках экспирации фьючерсного контракта.
OPERATION_TYPE_DELIVERY_SELL = 29
Продажа в рамках экспирации фьючерсного контракта.
OPERATION_TYPE_TRACK_MFEE = 30
Комиссия за управление по счету автоследования.
OPERATION_TYPE_TRACK_PFEE = 31
Комиссия за результат по счету автоследования.
OPERATION_TYPE_TAX_PROGRESSIVE = 32
Удержание налога по ставке 15%.
OPERATION_TYPE_BOND_TAX_PROGRESSIVE = 33
Удержание налога по купонам по ставке 15%.
OPERATION_TYPE_DIVIDEND_TAX_PROGRESSIVE = 34
Удержание налога по дивидендам по ставке 15%.
OPERATION_TYPE_BENEFIT_TAX_PROGRESSIVE = 35
Удержание налога за материальную выгоду по ставке 15%.
OPERATION_TYPE_TAX_CORRECTION_PROGRESSIVE = 36
Корректировка налога по ставке 15%.
OPERATION_TYPE_TAX_REPO_PROGRESSIVE = 37
Удержание налога за возмещение по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_TAX_REPO = 38
Удержание налога за возмещение по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_HOLD = 39
Удержание налога по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_REFUND = 40
Возврат налога по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_HOLD_PROGRESSIVE = 41
Удержание налога по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_TAX_REPO_REFUND_PROGRESSIVE = 42
Возврат налога по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_DIV_EXT = 43
Выплата дивидендов на карту.
OPERATION_TYPE_TAX_CORRECTION_COUPON = 44
Корректировка налога по купонам.
OPERATION_TYPE_CASH_FEE = 45
Комиссия за валютный остаток.
OPERATION_TYPE_OUT_FEE = 46
Комиссия за вывод валюты с брокерского счета.
OPERATION_TYPE_OUT_STAMP_DUTY = 47
Гербовый сбор.
OPERATION_TYPE_OUTPUT_SWIFT = 50
SWIFT-перевод.
OPERATION_TYPE_INPUT_SWIFT = 51
SWIFT-перевод.
OPERATION_TYPE_OUTPUT_ACQUIRING = 53
Перевод на карту.
OPERATION_TYPE_INPUT_ACQUIRING = 54
Перевод с карты.
OPERATION_TYPE_OUTPUT_PENALTY = 55
Комиссия за вывод средств.
OPERATION_TYPE_ADVICE_FEE = 56
Списание оплаты за сервис Советов.
OPERATION_TYPE_TRANS_IIS_BS = 57
Перевод ценных бумаг с ИИС на брокерский счет.
OPERATION_TYPE_TRANS_BS_BS = 58
Перевод ценных бумаг с одного брокерского счета на другой.
OPERATION_TYPE_OUT_MULTI = 59
Вывод денежных средств со счета.
OPERATION_TYPE_INP_MULTI = 60
Пополнение денежных средств со счета.
OPERATION_TYPE_OVER_PLACEMENT = 61
Размещение биржевого овернайта.
OPERATION_TYPE_OVER_COM = 62
Списание комиссии.
OPERATION_TYPE_OVER_INCOME = 63
Доход от оверанайта.
OPERATION_TYPE_OPTION_EXPIRATION = 64
Экспирация опциона.
OPERATION_TYPE_FUTURE_EXPIRATION = 65
Экспирация фьючерса.
message
operations.proto:52Запрос получения списка операций по счету.
Used as request type in: OperationsService.GetOperations, SandboxService.GetSandboxOperations
string account_id = 1
Идентификатор счета клиента.
optional from = 2
Начало периода по UTC.
optional to = 3
Окончание периода по UTC.
optional OperationState state = 4
Статус запрашиваемых операций.
optional string figi = 5
FIGI-идентификатор инструмента для фильтрации.
message
operations.proto:61Список операций.
Used as response type in: OperationsService.GetOperations, SandboxService.GetSandboxOperations
repeated operations = 1
Массив операций.
message
instruments.proto:327Опцион.
Used in: ,
string uid = 1
Уникальный идентификатор инструмента.
string position_uid = 2
Уникальный идентификатор позиции.
string ticker = 3
Тикер инструмента.
string class_code = 4
Класс-код.
string basic_asset_position_uid = 5
Уникальный идентификатор позиции основного инструмента.
SecurityTradingStatus trading_status = 21
Текущий режим торгов инструмента.
RealExchange real_exchange = 31
Реальная площадка исполнения расчетов (биржа).
OptionDirection direction = 41
Направление опциона.
OptionPaymentType payment_type = 42
Тип расчетов по опциону.
OptionStyle style = 43
Стиль опциона.
OptionSettlementType settlement_type = 44
Способ исполнения опциона.
string name = 101
Название инструмента.
string currency = 111
Валюта.
string settlement_currency = 112
Валюта, в которой оценивается контракт.
string asset_type = 131
Тип актива.
string basic_asset = 132
Основной актив.
string exchange = 141
Tорговая площадка (секция биржи).
string country_of_risk = 151
Код страны рисков.
string country_of_risk_name = 152
Наименование страны рисков.
string sector = 161
Сектор экономики.
optional brand = 162
Информация о бренде.
int32 lot = 201
Количество бумаг в лоте.
optional basic_asset_size = 211
Размер основного актива.
optional klong = 221
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 222
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 223
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 224
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 225
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 226
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional min_price_increment = 231
Минимальный шаг цены.
optional strike_price = 241
Цена страйка.
optional dlong_client = 290
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 291
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional expiration_date = 301
Дата истечения срока в формате UTC.
optional first_trade_date = 311
Дата начала обращения контракта в формате UTC.
optional last_trade_date = 312
Дата исполнения в формате UTC.
optional first_1min_candle_date = 321
Дата первой минутной свечи в формате UTC.
optional first_1day_candle_date = 322
Дата первой дневной свечи в формате UTC.
bool short_enabled_flag = 401
Признак доступности для операций шорт.
bool for_iis_flag = 402
Возможность покупки или продажи на ИИС.
bool otc_flag = 403
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 404
Признак доступности для покупки.
bool sell_available_flag = 405
Признак доступности для продажи.
bool for_qual_investor_flag = 406
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 407
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 408
Флаг заблокированного ТКС.
bool api_trade_available_flag = 409
Возможность торговать инструментом через API.
Тип опциона по направлению сделки.
Used in:
OPTION_DIRECTION_UNSPECIFIED = 0
Тип не определен.
OPTION_DIRECTION_PUT = 1
Опцион на продажу.
OPTION_DIRECTION_CALL = 2
Опцион на покупку.
Тип расчетов по опциону.
Used in:
OPTION_PAYMENT_TYPE_UNSPECIFIED = 0
Тип не определен.
OPTION_PAYMENT_TYPE_PREMIUM = 1
Опционы с использованием премии в расчетах.
OPTION_PAYMENT_TYPE_MARGINAL = 2
Маржируемые опционы.
Тип опциона по способу исполнения.
Used in:
OPTION_EXECUTION_TYPE_UNSPECIFIED = 0
Тип не определен.
OPTION_EXECUTION_TYPE_PHYSICAL_DELIVERY = 1
Поставочный тип опциона.
OPTION_EXECUTION_TYPE_CASH_SETTLEMENT = 2
Расчетный тип опциона.
Тип опциона по стилю.
Used in:
OPTION_STYLE_UNSPECIFIED = 0
Тип не определен.
OPTION_STYLE_AMERICAN = 1
Американский опцион.
OPTION_STYLE_EUROPEAN = 2
Европейский опцион.
message
instruments.proto:322Данные по опционам.
Used as response type in: InstrumentsService.Options, InstrumentsService.OptionsBy
repeated instruments = 1
Массив данных по опциону.
message
marketdata.proto:317Массив предложений/спроса.
Used in: ,
optional price = 1
Цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
int64 quantity = 2
Количество в лотах.
message
marketdata.proto:303Пакет стаканов в рамках стрима.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
int32 depth = 2
Глубина стакана.
bool is_consistent = 3
Флаг консистентности стакана. **false** — не все заявки попали в стакан из-за сетевых задержек или нарушения порядка доставки.
repeated bids = 4
Массив предложений.
repeated asks = 5
Массив спроса.
optional time = 6
Время формирования стакана в часовом поясе UTC по времени биржи.
optional limit_up = 7
Верхний лимит цены за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
optional limit_down = 8
Нижний лимит цены за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
string instrument_uid = 9
UID инструмента.
OrderBookType order_book_type = 10
Тип стакана.
message
marketdata.proto:172Запрос подписки на стаканы.
Used in:
string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`.
int32 depth = 2
Глубина стакана.
string instrument_id = 3
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
OrderBookType order_book_type = 4
Тип стакана. Значение по умолчанию — `ORDERBOOK_TYPE_ALL`, стакан биржевой и дилера.
message
marketdata.proto:186Статус подписки.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
int32 depth = 2
Глубина стакана.
SubscriptionStatus subscription_status = 3
Статус подписки.
string instrument_uid = 4
UID инструмента.
string stream_id = 5
Идентификатор открытого соединения.
string subscription_id = 6
Идентификатор подписки в формате `UUID`.
OrderBookType order_book_type = 7
Тип стакана.
Used in: , ,
ORDERBOOK_TYPE_UNSPECIFIED = 0
Не определен.
ORDERBOOK_TYPE_EXCHANGE = 1
Биржевой стакан.
ORDERBOOK_TYPE_DEALER = 2
Стакан дилера.
ORDERBOOK_TYPE_ALL = 3
Стакан биржевой и дилера.
Направление операции.
Used in: , , , , , ,
ORDER_DIRECTION_UNSPECIFIED = 0
Значение не указано
ORDER_DIRECTION_BUY = 1
Покупка
ORDER_DIRECTION_SELL = 2
Продажа
Текущий статус заявки (поручения)
Used in: , , ,
EXECUTION_REPORT_STATUS_UNSPECIFIED = 0
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
Частично исполнена
Тип идентификатора заявки
Used in: ,
ORDER_ID_TYPE_UNSPECIFIED = 0
Тип идентификатора не указан.
ORDER_ID_TYPE_EXCHANGE = 1
Биржевой идентификатор
ORDER_ID_TYPE_REQUEST = 2
Ключ идемпотентности, переданный клиентом
message
orders.proto:204Сделки в рамках торгового поручения.
Used in:
optional price = 1
Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
int64 quantity = 2
Количество лотов.
string trade_id = 3
Идентификатор сделки.
optional execution_time = 5
Время исполнения сделки
message
orders.proto:180Информация о торговом поручении.
Used as response type in: OrdersService.GetOrderState, SandboxService.GetSandboxOrderState
Used as field type in:
string order_id = 1
Биржевой идентификатор заявки.
OrderExecutionReportStatus execution_report_status = 2
Текущий статус заявки.
int64 lots_requested = 3
Запрошено лотов.
int64 lots_executed = 4
Исполнено лотов.
optional initial_order_price = 5
Начальная цена заявки. Произведение количества запрошенных лотов на цену.
optional executed_order_price = 6
Исполненная цена заявки. Произведение средней цены покупки на количество лотов.
optional total_order_amount = 7
Итоговая стоимость заявки, включающая все комиссии.
optional average_position_price = 8
Средняя цена позиции по сделке.
optional initial_commission = 9
Начальная комиссия. Комиссия, рассчитанная на момент подачи заявки.
optional executed_commission = 10
Фактическая комиссия по итогам исполнения заявки.
string figi = 11
Figi-идентификатор инструмента.
OrderDirection direction = 12
Направление заявки.
optional initial_security_price = 13
Начальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
repeated stages = 14
Стадии выполнения заявки.
optional service_commission = 15
Сервисная комиссия.
string currency = 16
Валюта заявки.
OrderType order_type = 17
Тип заявки.
optional order_date = 18
Дата и время выставления заявки в часовом поясе UTC.
string instrument_uid = 19
UID идентификатор инструмента.
string order_request_id = 20
Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов.
Маркер
Used in:
MARKER_UNKNOWN = 0
не определено
MARKER_BROKER = 1
сделки брокера
MARKER_CHAT = 2
исполнение поручение, полученного от клиента через каналы связи
MARKER_PAPER = 3
исполнение поручение, полученного от клиента в бумажной форме
MARKER_MARGIN = 4
принудительное закрытие позиций
MARKER_TKBNM = 5
сделки по управлению ликвидностью
MARKER_SHORT = 6
сделки РЕПО по привлечению у клиентов бумаг
MARKER_SPECMM = 7
перенос временно непокрытых позиций
MARKER_PO = 8
message
orders.proto:305Заявка
Used in:
string order_id = 1
Биржевой идентификатор заявки.
optional string order_request_id = 2
Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов.
string client_code = 3
Код клиента на бирже.
optional created_at = 4
Дата создания заявки.
OrderExecutionReportStatus execution_report_status = 5
Статус заявки.
optional StatusCauseInfo status_info = 6
Дополнительная информация по статусу.
string ticker = 7
Тикер инструмента.
string class_code = 8
Класс-код (секция торгов).
int32 lot_size = 9
Лотность инструмента заявки.
OrderDirection direction = 10
Направление заявки.
TimeInForceType time_in_force = 11
Алгоритм исполнения поручения.
OrderType order_type = 12
Тип заявки.
string account_id = 13
Номер счета.
optional initial_order_price = 22
Начальная цена заявки.
optional order_price = 23
Цена выставления заявки.
optional amount = 24
Предрассчитанная стоимость полной заявки.
optional executed_order_price = 25
Исполненная цена заявки.
string currency = 26
Валюта исполнения.
int64 lots_requested = 27
Запрошено лотов.
int64 lots_executed = 28
Исполнено лотов.
int64 lots_left = 29
Число неисполненных лотов по заявке.
int64 lots_cancelled = 30
Отмененные лоты.
optional MarkerType marker = 31
Спецсимвол.
repeated trades = 33
Список сделок.
optional completion_time = 35
Время исполнения заявки.
string exchange = 36
Код биржи.
string instrument_uid = 41
UID идентификатор инструмента.
Дополнительная информация по статусу заявки
Used in:
CAUSE_UNSPECIFIED = 0
Не определено
CAUSE_CANCELLED_BY_CLIENT = 15
Отменено клиентом
CAUSE_CANCELLED_BY_EXCHANGE = 1
Отменено биржей
CAUSE_CANCELLED_NOT_ENOUGH_POSITION = 2
Заявка не выставлена из-за нехватки средств
CAUSE_CANCELLED_BY_CLIENT_BLOCK = 3
Отменено из-за блокировки клиента
CAUSE_REJECTED_BY_BROKER = 4
Отклонено брокером
CAUSE_REJECTED_BY_EXCHANGE = 5
Отклонено биржей
CAUSE_CANCELLED_BY_BROKER = 6
Отменено брокером
message
orders.proto:80Информация о сделке.
Used in: ,
optional date_time = 1
Дата и время совершения сделки в часовом поясе UTC.
optional price = 2
Цена за 1 инструмент, по которой совершена сделка.
int64 quantity = 3
Количество штук в сделке.
string trade_id = 4
Идентификатор сделки.
message
orders.proto:69Информация об исполнении торгового поручения.
Used in:
string order_id = 1
Идентификатор торгового поручения.
optional created_at = 2
Дата и время создания сообщения в часовом поясе UTC.
OrderDirection direction = 3
Направление сделки.
string figi = 4
Figi-идентификатор инструмента.
repeated trades = 5
Массив сделок.
string account_id = 6
Идентификатор счета.
string instrument_uid = 7
UID идентификатор инструмента.
Тип заявки.
Used in: , , , ,
ORDER_TYPE_UNSPECIFIED = 0
Значение не указано
ORDER_TYPE_LIMIT = 1
Лимитная
ORDER_TYPE_MARKET = 2
Рыночная
ORDER_TYPE_BESTPRICE = 3
Лучшая цена
message
common.proto:102Used in: , ,
int32 limit = 1
Максимальное число возвращаемых записей.
int32 page_number = 2
Порядковый номер страницы, начиная с 0.
message
common.proto:107Used in: , ,
int32 limit = 1
Максимальное число возвращаемых записей.
int32 page_number = 2
Порядковый номер страницы, начиная с 0.
int32 total_count = 3
Общее количество записей.
message
common.proto:89Проверка активности стрима.
Used in: , , , ,
optional time = 1
Время проверки.
string stream_id = 2
Идентификатор соединения.
optional ping_request_time = 4
Время формирования запроса.
message
common.proto:84Used in: , , ,
optional int32 ping_delay_ms = 15
Задержка (пинг) сообщений: 5000–180 000 миллисекунд. Значение по умолчанию — 120 000.
message
common.proto:80Used in:
optional time = 1
Время формирования запроса.
message
operations.proto:154Позиции портфеля.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
string instrument_type = 2
Тип инструмента.
optional quantity = 3
Количество инструмента в портфеле в штуках.
optional average_position_price = 4
Средневзвешенная цена позиции. Для пересчета возможна задержка до одной секунды.
optional expected_yield = 5
Текущая рассчитанная доходность позиции.
optional current_nkd = 6
Текущий НКД.
optional average_position_price_pt = 7
Deprecated Средняя цена позиции в пунктах (для фьючерсов). Для пересчета возможна задержка до одной секунды.
optional current_price = 8
Текущая цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
optional average_position_price_fifo = 9
Средняя цена позиции по методу FIFO. Для пересчета возможна задержка до одной секунды.
optional quantity_lots = 10
Deprecated Количество лотов в портфеле.
bool blocked = 21
Заблокировано на бирже.
optional blocked_lots = 22
Количество бумаг, заблокированных выставленными заявками.
string position_uid = 24
Уникальный идентификатор позиции.
string instrument_uid = 25
Уникальный идентификатор инструмента.
optional var_margin = 26
Вариационная маржа.
optional expected_yield_fifo = 27
Текущая рассчитанная доходность позиции.
optional daily_yield = 31
Рассчитанная доходность портфеля за день.
string ticker = 32
Тикер инструмента.
message
operations.proto:96Запрос получения текущего портфеля по счету.
Used as request type in: OperationsService.GetPortfolio, SandboxService.GetSandboxPortfolio
string account_id = 1
Идентификатор счета пользователя.
optional PortfolioRequest.CurrencyRequest currency = 2
Валюта, в которой нужно рассчитать портфель.
Used in:
RUB = 0
Рубли
USD = 1
Доллары
EUR = 2
Евро
message
operations.proto:107Текущий портфель по счету.
Used as response type in: OperationsService.GetPortfolio, SandboxService.GetSandboxPortfolio
Used as field type in:
optional total_amount_shares = 1
Общая стоимость акций в портфеле.
optional total_amount_bonds = 2
Общая стоимость облигаций в портфеле.
optional total_amount_etf = 3
Общая стоимость фондов в портфеле.
optional total_amount_currencies = 4
Общая стоимость валют в портфеле.
optional total_amount_futures = 5
Общая стоимость фьючерсов в портфеле.
optional expected_yield = 6
Текущая относительная доходность портфеля в %.
repeated positions = 7
Список позиций портфеля.
string account_id = 8
Идентификатор счета пользователя.
optional total_amount_options = 9
Общая стоимость опционов в портфеле.
optional total_amount_sp = 10
Общая стоимость структурных нот в портфеле.
optional total_amount_portfolio = 11
Общая стоимость портфеля.
repeated virtual_positions = 12
Массив виртуальных позиций портфеля.
optional daily_yield = 15
Рассчитанная доходность портфеля за день в рублях.
optional daily_yield_relative = 16
Относительная доходность в день в %.
message
operations.proto:434Объект результата подписки.
Used in:
repeated accounts = 1
Массив счетов клиента.
string tracking_id = 7
Уникальный идентификатор запроса, подробнее: [tracking_id](/invest/intro/developer/protocols/grpc#tracking-id).
string stream_id = 8
Идентификатор открытого соединения
Результат подписки.
Used in:
PORTFOLIO_SUBSCRIPTION_STATUS_UNSPECIFIED = 0
Тип не определен.
PORTFOLIO_SUBSCRIPTION_STATUS_SUCCESS = 1
Успешно.
PORTFOLIO_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND = 2
Счет не найден или недостаточно прав.
PORTFOLIO_SUBSCRIPTION_STATUS_INTERNAL_ERROR = 3
Произошла ошибка.
message
operations.proto:562Данные о позиции портфеля.
Used in:
string account_id = 1
Идентификатор счета.
repeated money = 2
Массив валютных позиций портфеля.
repeated securities = 3
Список ценно-бумажных позиций портфеля.
repeated futures = 4
Список фьючерсов портфеля.
repeated options = 5
Список опционов портфеля.
optional date = 6
Дата и время операции в формате UTC.
Результат подписки.
Used in:
POSITIONS_SUBSCRIPTION_STATUS_UNSPECIFIED = 0
Тип не определен.
POSITIONS_SUBSCRIPTION_STATUS_SUCCESS = 1
Успешно.
POSITIONS_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND = 2
Счет не найден или недостаточно прав.
POSITIONS_SUBSCRIPTION_STATUS_INTERNAL_ERROR = 3
Произошла ошибка.
message
operations.proto:204Баланс фьючерса.
Used in: ,
string figi = 1
FIGI-идентификатор фьючерса.
int64 blocked = 2
Количество бумаг, заблокированных выставленными заявками.
int64 balance = 3
Текущий незаблокированный баланс.
string position_uid = 4
Уникальный идентификатор позиции.
string instrument_uid = 5
Уникальный идентификатор инструмента.
string ticker = 6
Тикер инструмента.
message
operations.proto:572Валютная позиция портфеля.
Used in:
optional available_value = 1
Доступное количество валютный позиций.
optional blocked_value = 2
Заблокированное количество валютных позиций.
message
operations.proto:214Баланс опциона.
Used in: ,
string position_uid = 1
Уникальный идентификатор позиции опциона.
string instrument_uid = 2
Уникальный идентификатор инструмента.
string ticker = 3
Тикер инструмента.
int64 blocked = 11
Количество бумаг, заблокированных выставленными заявками.
int64 balance = 21
Текущий незаблокированный баланс.
message
operations.proto:126Запрос позиций портфеля по счету.
Used as request type in: OperationsService.GetPositions, SandboxService.GetSandboxPositions
string account_id = 1
Идентификатор счета пользователя.
message
operations.proto:131Список позиций по счету.
Used as response type in: OperationsService.GetPositions, SandboxService.GetSandboxPositions
Used as field type in:
repeated money = 1
Массив валютных позиций портфеля.
repeated blocked = 2
Массив заблокированных валютных позиций портфеля.
repeated securities = 3
Список ценно-бумажных позиций портфеля.
bool limits_loading_in_progress = 4
Признак идущей выгрузки лимитов в данный момент.
repeated futures = 5
Список фьючерсов портфеля.
repeated options = 6
Список опционов портфеля.
string account_id = 15
Идентификатор счёта пользователя.
message
operations.proto:192Баланс позиции ценной бумаги.
Used in: ,
string figi = 1
FIGI-идентификатор бумаги.
int64 blocked = 2
Количество бумаг, заблокированных выставленными заявками.
int64 balance = 3
Текущий незаблокированный баланс.
string position_uid = 4
Уникальный идентификатор позиции.
string instrument_uid = 5
Уникальный идентификатор инструмента.
string ticker = 6
Тикер инструмента.
bool exchange_blocked = 11
Заблокировано на бирже.
string instrument_type = 16
Тип инструмента.
message
operations.proto:541Объект результата подписки.
Used in:
repeated accounts = 1
Массив счетов клиента.
string tracking_id = 7
Уникальный идентификатор запроса, подробнее: [tracking_id](/invest/intro/developer/protocols/grpc#tracking-id).
string stream_id = 8
Идентификатор открытого соединения
message
operations.proto:548Счет клиента.
Used in:
string account_id = 1
Идентификатор счета.
PositionsAccountSubscriptionStatus subscription_status = 6
Результат подписки.
message
orders.proto:129Запрос выставления асинхронного торгового поручения.
Used as request type in: OrdersService.PostOrderAsync, SandboxService.PostSandboxOrderAsync
string instrument_id = 1
Идентификатор инструмента, принимает значения Figi или Instrument_uid.
int64 quantity = 2
Количество лотов.
optional price = 3
Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента. Игнорируется для рыночных поручений.
OrderDirection direction = 4
Направление операции.
string account_id = 5
Номер счета.
OrderType order_type = 6
Тип заявки.
string order_id = 7
Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина 36 символов.
optional TimeInForceType time_in_force = 8
Алгоритм исполнения поручения, применяется только к лимитной заявке.
optional PriceType price_type = 9
Тип цены.
message
orders.proto:142Результат выставления асинхронного торгового поручения.
Used as response type in: OrdersService.PostOrderAsync, SandboxService.PostSandboxOrderAsync
string order_request_id = 1
Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов.
OrderExecutionReportStatus execution_report_status = 2
Текущий статус заявки.
optional string trade_intent_id = 3
Идентификатор торгового поручения.
message
orders.proto:88Запрос выставления торгового поручения.
Used as request type in: OrdersService.PostOrder, SandboxService.PostSandboxOrder
optional string figi = 1
Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
int64 quantity = 2
Количество лотов.
optional price = 3
Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента. Игнорируется для рыночных поручений.
OrderDirection direction = 4
Направление операции.
string account_id = 5
Номер счета.
OrderType order_type = 6
Тип заявки.
string order_id = 7
Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина 36 символов.
string instrument_id = 8
Идентификатор инструмента, принимает значения Figi или Instrument_uid.
TimeInForceType time_in_force = 9
Алгоритм исполнения поручения, применяется только к лимитной заявке.
PriceType price_type = 10
Тип цены.
message
orders.proto:104Информация о выставлении поручения.
Used as response type in: OrdersService.PostOrder, OrdersService.ReplaceOrder, SandboxService.PostSandboxOrder, SandboxService.ReplaceSandboxOrder
string order_id = 1
Биржевой идентификатор заявки.
OrderExecutionReportStatus execution_report_status = 2
Текущий статус заявки.
int64 lots_requested = 3
Запрошено лотов.
int64 lots_executed = 4
Исполнено лотов.
optional initial_order_price = 5
Начальная цена заявки. Произведение количества запрошенных лотов на цену.
optional executed_order_price = 6
Исполненная средняя цена одного инструмента в заявке.
optional total_order_amount = 7
Итоговая стоимость заявки, включающая все комиссии.
optional initial_commission = 8
Начальная комиссия. Комиссия рассчитанная при выставлении заявки.
optional executed_commission = 9
Фактическая комиссия по итогам исполнения заявки.
optional aci_value = 10
Значение НКД (накопленного купонного дохода) на дату. Подробнее: [НКД при выставлении торговых поручений](./head-orders#coupon)
string figi = 11
Figi-идентификатор инструмента.
OrderDirection direction = 12
Направление сделки.
optional initial_security_price = 13
Начальная цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
OrderType order_type = 14
Тип заявки.
string message = 15
Дополнительные данные об исполнении заявки.
optional initial_order_price_pt = 16
Начальная цена заявки в пунктах (для фьючерсов).
string instrument_uid = 17
UID идентификатор инструмента.
string order_request_id = 20
Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов.
optional response_metadata = 254
Метадата
message
stoporders.proto:45Used in:
optional indent = 1
Отступ.
TrailingValueType indent_type = 2
Тип величины отступа.
optional spread = 3
Размер защитного спреда.
TrailingValueType spread_type = 4
Тип величины защитного спреда.
Тип цены.
Used in: , , , ,
PRICE_TYPE_UNSPECIFIED = 0
Значение не определено.
PRICE_TYPE_POINT = 1
Цена в пунктах (только для фьючерсов и облигаций).
PRICE_TYPE_CURRENCY = 2
Цена в валюте расчетов по инструменту.
message
common.proto:50Котировка — денежная сумма без указания валюты.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
int64 units = 1
Целая часть суммы, может быть отрицательным числом.
int32 nano = 2
Дробная часть суммы, может быть отрицательным числом.
Реальная площадка исполнения расчетов.
Used in: , , , , , ,
REAL_EXCHANGE_UNSPECIFIED = 0
Тип не определен.
REAL_EXCHANGE_MOEX = 1
Московская биржа.
REAL_EXCHANGE_RTS = 2
Санкт-Петербургская биржа.
REAL_EXCHANGE_OTC = 3
Внебиржевой инструмент.
REAL_EXCHANGE_DEALER = 4
Инструмент, торгуемый на площадке брокера.
Used in: , ,
RECOMMENDATION_UNSPECIFIED = 0
Не определено.
RECOMMENDATION_BUY = 1
Покупать.
RECOMMENDATION_HOLD = 2
Держать.
RECOMMENDATION_SELL = 3
Продавать.
message
orders.proto:212Запрос изменения выставленной заявки.
Used as request type in: OrdersService.ReplaceOrder, SandboxService.ReplaceSandboxOrder
string account_id = 1
Номер счета.
string order_id = 6
Идентификатор заявки на бирже.
string idempotency_key = 7
Новый идентификатор запроса выставления поручения для целей идемпотентности. Максимальная длина 36 символов. Перезатирает старый ключ.
int64 quantity = 11
Количество лотов.
optional price = 12
Цена за 1 инструмент.
optional PriceType price_type = 13
Тип цены.
message
common.proto:113Used in: , ,
string tracking_id = 42
Идентификатор трекинга.
optional server_time = 43
Серверное время.
Used in:
RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED = 0
Статус подписки не определен.
RESULT_SUBSCRIPTION_STATUS_OK = 1
Подписка успешно установлена.
RESULT_SUBSCRIPTION_STATUS_ERROR = 13
Ошибка подписки
Уровень риска облигации.
Used in:
RISK_LEVEL_UNSPECIFIED = 0
Не указан.
RISK_LEVEL_LOW = 1
Низкий уровень риска.
RISK_LEVEL_MODERATE = 2
Средний уровень риска.
RISK_LEVEL_HIGH = 3
Высокий уровень риска.
message
instruments.proto:1448Used in:
string risk_level_code = 2
Категория риска.
optional value = 5
Значение ставки риска.
message
instruments.proto:1440Used in:
string instrument_uid = 1
optional short_risk_rate = 2
Ставка риска пользователя в шорт
optional long_risk_rate = 3
Ставка риска пользователя в лонг
repeated short_risk_rates = 5
Доступные ставки риска в шорт
repeated long_risk_rates = 6
Доступные ставки риска в лонг
optional string error = 9
Ошибка.
Режим торгов инструмента
Used in: , , , , , , , ,
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
Недоступна торговля в режиме внутренней ликвидности брокера.
message
instruments.proto:654Объект передачи информации об акции.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
string ticker = 2
Тикер инструмента.
string class_code = 3
Класс-код (секция торгов).
string isin = 4
ISIN-идентификатор инструмента.
int32 lot = 5
Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)
string currency = 6
Валюта расчетов.
optional klong = 7
Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional kshort = 8
Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР).
optional dlong = 9
Ставка риска начальной маржи для КСУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort = 10
Ставка риска начальной маржи для КСУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dlong_min = 11
Ставка риска начальной маржи для КПУР лонг. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_min = 12
Ставка риска начальной маржи для КПУР шорт. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
bool short_enabled_flag = 13
Признак доступности для операций в шорт.
string name = 15
Название инструмента.
string exchange = 16
Tорговая площадка (секция биржи).
optional ipo_date = 17
Дата IPO акции по UTC.
int64 issue_size = 18
Размер выпуска.
string country_of_risk = 19
Код страны риска — то есть страны, в которой компания ведет основной бизнес.
string country_of_risk_name = 20
Наименование страны риска — то есть страны, в которой компания ведет основной бизнес.
string sector = 21
Сектор экономики.
int64 issue_size_plan = 22
Плановый размер выпуска.
optional nominal = 23
Номинал.
SecurityTradingStatus trading_status = 25
Текущий режим торгов инструмента.
bool otc_flag = 26
Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке.
bool buy_available_flag = 27
Признак доступности для покупки.
bool sell_available_flag = 28
Признак доступности для продажи.
bool div_yield_flag = 29
Признак наличия дивидендной доходности.
ShareType share_type = 30
Тип акции. Возможные значения — `[ShareType](./instruments#sharetype)`.
optional min_price_increment = 31
Шаг цены.
bool api_trade_available_flag = 32
Возможность торговать инструментом через API.
string uid = 33
Уникальный идентификатор инструмента.
RealExchange real_exchange = 34
Реальная площадка исполнения расчетов (биржа).
string position_uid = 35
Уникальный идентификатор позиции инструмента.
string asset_uid = 36
Уникальный идентификатор актива.
InstrumentExchangeType instrument_exchange = 37
Тип площадки торговли.
bool for_iis_flag = 46
Признак доступности для ИИС.
bool for_qual_investor_flag = 47
Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов.
bool weekend_flag = 48
Флаг, отображающий доступность торговли инструментом по выходным.
bool blocked_tca_flag = 49
Флаг заблокированного ТКС.
bool liquidity_flag = 50
Флаг достаточной ликвидности.
optional first_1min_candle_date = 56
Дата первой минутной свечи.
optional first_1day_candle_date = 57
Дата первой дневной свечи.
optional brand = 60
Информация о бренде.
optional dlong_client = 90
Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
optional dshort_client = 91
Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. [Подробнее про ставки риска](https://www.tbank.ru/invest/help/brokerage/account/margin/about/#q5).
Тип акций.
Used in: ,
SHARE_TYPE_UNSPECIFIED = 0
Значение не определено.
SHARE_TYPE_COMMON = 1
Обыкновенная.
SHARE_TYPE_PREFERRED = 2
Привилегированная.
SHARE_TYPE_ADR = 3
Американские депозитарные расписки.
SHARE_TYPE_GDR = 4
Глобальные депозитарные расписки.
SHARE_TYPE_MLP = 5
Товарищество с ограниченной ответственностью.
SHARE_TYPE_NY_REG_SHRS = 6
Акции из реестра Нью-Йорка.
SHARE_TYPE_CLOSED_END_FUND = 7
Закрытый инвестиционный фонд.
SHARE_TYPE_REIT = 8
Траст недвижимости.
message
signals.proto:71Сигнал.
Used in:
string signal_id = 1
Идентификатор сигнала.
string strategy_id = 2
Идентификатор стратегии.
string strategy_name = 3
Название стратегии.
string instrument_uid = 4
Идентификатор бумаги.
optional create_dt = 5
Дата и время создания сигнала по UTC.
SignalDirection direction = 6
Направление сигнала.
optional initial_price = 7
Цена бумаги на момент формирования сигнала.
optional string info = 8
Дополнительная информация о сигнале.
string name = 9
Название сигнала.
optional target_price = 10
Целевая цена.
optional end_dt = 11
Дата и время дедлайна сигнала по UTC.
optional int32 probability = 12
Вероятность сигнала.
optional stoploss = 13
Порог закрытия сигнала по стоплосс.
optional close_price = 14
Цена закрытия сигнала.
optional close_dt = 15
Дата и время закрытия сигнала по UTC.
Направление сигнала.
Used in: ,
SIGNAL_DIRECTION_UNSPECIFIED = 0
Не определен.
SIGNAL_DIRECTION_BUY = 1
Покупка.
SIGNAL_DIRECTION_SELL = 2
Продажа.
Статус сигнала.
Used in:
SIGNAL_STATE_UNSPECIFIED = 0
Не определен.
SIGNAL_STATE_ACTIVE = 1
Активный сигнал.
SIGNAL_STATE_CLOSED = 2
Закрытый сигнал.
SIGNAL_STATE_ALL = 3
Все состояния.
message
stoporders.proto:85Информация о стоп-заявке.
Used in:
string stop_order_id = 1
Уникальный идентификатор стоп-заявки.
int64 lots_requested = 2
Запрошено лотов.
string figi = 3
FIGI-идентификатор инструмента.
StopOrderDirection direction = 4
Направление операции.
string currency = 5
Валюта стоп-заявки.
StopOrderType order_type = 6
Тип стоп-заявки.
optional create_date = 7
Дата и время выставления заявки по UTC.
optional activation_date_time = 8
Дата и время конвертации стоп-заявки в биржевую по UTC.
optional expiration_time = 9
Дата и время снятия заявки по UTC.
optional price = 10
Цена заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
optional stop_price = 11
Цена активации стоп-заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
string instrument_uid = 12
`instrument_uid`-идентификатор инструмента.
TakeProfitType take_profit_type = 13
Подтип стоп-заявки — `TakeProfit`.
optional trailing_data = 14
Параметры трейлинг-стопа.
StopOrderStatusOption status = 15
Статус заявки.
ExchangeOrderType exchange_order_type = 16
Тип дочерней биржевой заявки для тейкпрофита.
optional string exchange_order_id = 17
Идентификатор биржевой заявки.
message
stoporders.proto:103Used in:
optional indent = 1
Отступ.
TrailingValueType indent_type = 2
Тип величины отступа.
optional spread = 3
Размер защитного спреда.
TrailingValueType spread_type = 4
Тип величины защитного спреда.
TrailingStopStatus status = 5
Статус трейлинг-стопа.
optional price = 7
Цена исполнения.
optional extr = 8
Локальный экстремум.
Направление сделки стоп-заявки.
Used in: ,
STOP_ORDER_DIRECTION_UNSPECIFIED = 0
Значение не указано.
STOP_ORDER_DIRECTION_BUY = 1
Покупка.
STOP_ORDER_DIRECTION_SELL = 2
Продажа.
Тип экспирации стоп-заявке.
Used in:
STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED = 0
Значение не указано.
STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL = 1
Действительно до отмены.
STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE = 2
Действительно до даты снятия.
Статус стоп-заяки.
Used in: ,
STOP_ORDER_STATUS_UNSPECIFIED = 0
Значение не указано.
STOP_ORDER_STATUS_ALL = 1
Все заявки.
STOP_ORDER_STATUS_ACTIVE = 2
Активные заявки.
STOP_ORDER_STATUS_EXECUTED = 3
Исполненные заявки.
STOP_ORDER_STATUS_CANCELED = 4
Отмененные заявки.
STOP_ORDER_STATUS_EXPIRED = 5
Истекшие заявки.
Тип стоп-заявки.
Used in: ,
STOP_ORDER_TYPE_UNSPECIFIED = 0
Значение не указано.
STOP_ORDER_TYPE_TAKE_PROFIT = 1
`Take-profit`-заявка.
STOP_ORDER_TYPE_STOP_LOSS = 2
`Stop-loss`-заявка.
STOP_ORDER_TYPE_STOP_LIMIT = 3
`Stop-limit`-заявка.
message
signals.proto:36Стратегия
Used in:
string strategy_id = 1
Идентификатор стратегии.
string strategy_name = 2
Название стратегии.
optional string strategy_description = 3
Описание стратегии.
optional string strategy_url = 4
Ссылка на страницу с описанием стратегии.
StrategyType strategy_type = 5
Тип стратегии.
int32 active_signals = 6
Количество активных сигналов.
int32 total_signals = 7
Общее количество сигналов.
int64 time_in_position = 8
Среднее время нахождения сигнала в позиции.
optional average_signal_yield = 9
Средняя доходность сигнала в стратегии.
optional average_signal_yield_year = 10
Средняя доходность сигналов в стратегии за последний год.
optional yield = 11
Доходность стратегии.
optional yield_year = 12
Доходность стратегии за последний год.
Тип стратегии.
Used in: ,
STRATEGY_TYPE_UNSPECIFIED = 0
Не определен.
STRATEGY_TYPE_TECHNICAL = 1
Техническая стратегия.
STRATEGY_TYPE_FUNDAMENTAL = 2
Фундаментальная стратегия.
message
users.proto:136Лимит stream-соединений.
Used in:
int32 limit = 1
Максимальное количество stream-соединений.
repeated string streams = 2
Названия stream-методов.
int32 open = 3
Текущее количество открытых stream-соединений.
Тип структурной ноты.
Used in:
SP_TYPE_UNSPECIFIED = 0
Тип не определен.
SP_TYPE_DELIVERABLE = 1
Поставочный.
SP_TYPE_NON_DELIVERABLE = 2
Беспоставочный.
message
marketdata.proto:93subscribeCandles | Изменения статуса подписки на свечи.
Used in: ,
SubscriptionAction subscription_action = 1
Изменение статуса подписки.
repeated instruments = 2
Массив инструментов для подписки на свечи.
bool waiting_close = 3
Флаг ожидания закрытия временного интервала для отправки свечи.
optional GetCandlesRequest.CandleSource candle_source_type = 9
Источник свечей.
message
marketdata.proto:133Результат изменения статус подписки на свечи.
Used in:
string tracking_id = 1
Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id).
repeated candles_subscriptions = 2
Массив статусов подписки на свечи.
message
marketdata.proto:234Изменение статуса подписки на торговый статус инструмента.
Used in: ,
SubscriptionAction subscription_action = 1
Изменение статуса подписки.
repeated instruments = 2
Массив инструментов для подписки на торговый статус.
message
marketdata.proto:246Результат изменения статуса подписки на торговый статус.
Used in:
string tracking_id = 1
Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id).
repeated info_subscriptions = 2
Массив статусов подписки на торговый статус.
message
marketdata.proto:261Изменение статуса подписки на цену последней сделки по инструменту.
Used in: ,
SubscriptionAction subscription_action = 1
Изменение статуса подписки.
repeated instruments = 2
Массив инструментов для подписки на цену последней сделки.
message
marketdata.proto:273Результат изменения статуса подписки на цену последней сделки.
Used in:
string tracking_id = 1
Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id).
repeated last_price_subscriptions = 2
Массив статусов подписки на цену последней сделки.
message
marketdata.proto:166Запрос на изменение статуса подписки на стаканы.
Used in: ,
SubscriptionAction subscription_action = 1
Изменение статуса подписки.
repeated instruments = 2
Массив инструментов для подписки на стаканы.
message
marketdata.proto:180Результат изменения статуса подписки на стаканы.
Used in:
string tracking_id = 1
Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id).
repeated order_book_subscriptions = 2
Массив статусов подписки на стаканы.
message
marketdata.proto:205Изменение статуса подписки на поток обезличенных сделок.
Used in: ,
SubscriptionAction subscription_action = 1
Изменение статуса подписки.
repeated instruments = 2
Массив инструментов для подписки на поток обезличенных сделок.
TradeSourceType trade_source = 3
Тип источника сделок. Значение по умолчанию — `TRADE_SOURCE_ALL`, все сделки.
message
marketdata.proto:218Результат изменения статуса подписки на поток обезличенных сделок.
Used in:
string tracking_id = 1
Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id).
repeated trade_subscriptions = 2
Массив статусов подписки на поток сделок.
TradeSourceType trade_source = 3
Тип источника сделок.
Тип операции со списком подписок.
Used in: , , , ,
SUBSCRIPTION_ACTION_UNSPECIFIED = 0
Статус подписки не определен.
SUBSCRIPTION_ACTION_SUBSCRIBE = 1
Подписаться.
SUBSCRIPTION_ACTION_UNSUBSCRIBE = 2
Отписаться.
Интервал свечи.
Used in: , ,
SUBSCRIPTION_INTERVAL_UNSPECIFIED = 0
Интервал свечи не определен.
SUBSCRIPTION_INTERVAL_ONE_MINUTE = 1
Минутные свечи.
SUBSCRIPTION_INTERVAL_FIVE_MINUTES = 2
Пятиминутные свечи.
SUBSCRIPTION_INTERVAL_FIFTEEN_MINUTES = 3
Пятнадцатиминутные свечи.
SUBSCRIPTION_INTERVAL_ONE_HOUR = 4
Часовые свечи.
SUBSCRIPTION_INTERVAL_ONE_DAY = 5
Дневные свечи.
SUBSCRIPTION_INTERVAL_2_MIN = 6
Двухминутные свечи.
SUBSCRIPTION_INTERVAL_3_MIN = 7
Трехминутные свечи.
SUBSCRIPTION_INTERVAL_10_MIN = 8
Десятиминутные свечи.
SUBSCRIPTION_INTERVAL_30_MIN = 9
Тридцатиминутные свечи.
SUBSCRIPTION_INTERVAL_2_HOUR = 10
Двухчасовые свечи.
SUBSCRIPTION_INTERVAL_4_HOUR = 11
Четырехчасовые свечи.
SUBSCRIPTION_INTERVAL_WEEK = 12
Недельные свечи.
SUBSCRIPTION_INTERVAL_MONTH = 13
Месячные свечи.
message
orders.proto:288Информация по подпискам
Used in: ,
string tracking_id = 1
Уникальный идентификатор запроса, подробнее: [tracking_id](./grpc#tracking-id).
ResultSubscriptionStatus status = 2
Статус подписки.
string stream_id = 4
Идентификатор открытого соединения
repeated string accounts = 5
Идентификаторы счетов.
optional error = 7
Результат подписки.
Used in: , , , ,
SUBSCRIPTION_STATUS_UNSPECIFIED = 0
Статус подписки не определен.
SUBSCRIPTION_STATUS_SUCCESS = 1
Успешно.
SUBSCRIPTION_STATUS_INSTRUMENT_NOT_FOUND = 2
Инструмент не найден.
SUBSCRIPTION_STATUS_SUBSCRIPTION_ACTION_IS_INVALID = 3
Некорректный статус подписки. [Список возможных значений](./marketdata#subscriptionaction).
SUBSCRIPTION_STATUS_DEPTH_IS_INVALID = 4
Некорректная глубина стакана. Доступные значения — 1, 10, 20, 30, 40, 50.
SUBSCRIPTION_STATUS_INTERVAL_IS_INVALID = 5
Некорректный интервал свечей. [Список возможных значений](./marketdata#subscriptioninterval).
SUBSCRIPTION_STATUS_LIMIT_IS_EXCEEDED = 6
Превышен лимит на общее количество подписок в рамках стрима. [Лимитная политика](./limits/).
SUBSCRIPTION_STATUS_INTERNAL_ERROR = 7
Внутренняя ошибка сервиса.
SUBSCRIPTION_STATUS_TOO_MANY_REQUESTS = 8
Превышен лимит на количество запросов на подписки в течение установленного отрезка времени.
SUBSCRIPTION_STATUS_SUBSCRIPTION_NOT_FOUND = 9
Активная подписка не найдена. Ошибка может возникнуть только при отписке от несуществующей подписки.
SUBSCRIPTION_STATUS_SOURCE_IS_INVALID = 10
Указан некорректный источник.
Тип TakeProfit-заявки.
Used in: ,
TAKE_PROFIT_TYPE_UNSPECIFIED = 0
Значение не указано.
TAKE_PROFIT_TYPE_REGULAR = 1
Обычная заявка, значение по умолчанию.
TAKE_PROFIT_TYPE_TRAILING = 2
Трейлинг-стоп.
Алгоритм исполнения заявки
Used in: , ,
TIME_IN_FORCE_UNSPECIFIED = 0
Значение не определено см. TIME_IN_FORCE_DAY
TIME_IN_FORCE_DAY = 1
Заявка действует до конца торгового дня. Значение по умолчанию
TIME_IN_FORCE_FILL_AND_KILL = 2
Если в момент выставления возможно исполнение заявки(в т.ч. частичное), заявка будет исполнена или отменена сразу после выставления
TIME_IN_FORCE_FILL_OR_KILL = 3
Если в момент выставления возможно полное исполнение заявки, заявка будет исполнена или отменена сразу после выставления, недоступно для срочного рынка и торговли по выходным
message
marketdata.proto:323Информация о сделке.
Used in: ,
string figi = 1
FIGI-идентификатор инструмента.
TradeDirection direction = 2
Направление сделки.
optional price = 3
Цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. [Подробнее про перевод цен в валюту](./faq_marketdata/#_15).
int64 quantity = 4
Количество лотов.
optional time = 5
Время сделки в часовом поясе UTC по времени биржи.
string instrument_uid = 6
UID инструмента.
TradeSourceType trade_source = 7
Тип источника сделки.
Направление сделки.
Used in:
TRADE_DIRECTION_UNSPECIFIED = 0
Направление сделки не определено.
TRADE_DIRECTION_BUY = 1
Покупка.
TRADE_DIRECTION_SELL = 2
Продажа.
message
marketdata.proto:212Запрос подписки на поток обезличенных сделок.
Used in:
string figi = 1
Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`.
string instrument_id = 2
Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`.
Типы источников сделок.
Used in: , , ,
TRADE_SOURCE_UNSPECIFIED = 0
Тип источника сделки не определён.
TRADE_SOURCE_EXCHANGE = 1
Биржевые сделки.
TRADE_SOURCE_DEALER = 2
Сделки дилера.
TRADE_SOURCE_ALL = 3
Все сделки.
message
marketdata.proto:225Статус подписки.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SubscriptionStatus subscription_status = 2
Статус подписки.
string instrument_uid = 3
UID инструмента.
string stream_id = 4
Идентификатор открытого соединения.
string subscription_id = 5
Идентификатор подписки в формате UUID.
message
instruments.proto:154Информация о времени торгов.
Used in:
optional date = 1
Дата.
bool is_trading_day = 2
Признак торгового дня на бирже.
optional start_time = 3
Время начала торгов по UTC.
optional end_time = 4
Время окончания торгов по UTC.
optional opening_auction_start_time = 7
Время начала аукциона открытия по UTC.
optional closing_auction_end_time = 8
Время окончания аукциона закрытия по UTC.
optional evening_opening_auction_start_time = 9
Время начала аукциона открытия вечерней сессии по UTC.
optional evening_start_time = 10
Время начала вечерней сессии по UTC.
optional evening_end_time = 11
Время окончания вечерней сессии по UTC.
optional clearing_start_time = 12
Время начала основного клиринга по UTC.
optional clearing_end_time = 13
Время окончания основного клиринга по UTC.
optional premarket_start_time = 14
Время начала премаркета по UTC.
optional premarket_end_time = 15
Время окончания премаркета по UTC.
optional closing_auction_start_time = 16
Время начала аукциона закрытия по UTC.
optional opening_auction_end_time = 17
Время окончания аукциона открытия по UTC.
repeated intervals = 18
Торговые интервалы.
message
instruments.proto:1454Used in:
string type = 1
Название интервала.
optional interval = 2
Интервал.
message
instruments.proto:1458Used in:
optional start_ts = 1
Время начала интервала.
optional end_ts = 2
Время окончания интервала.
message
instruments.proto:148Данные по торговой площадке.
Used in:
string exchange = 1
Наименование торговой площадки.
repeated days = 2
Массив с торговыми и неторговыми днями.
message
marketdata.proto:341Пакет изменения торгового статуса.
Used in:
string figi = 1
FIGI-идентификатор инструмента.
SecurityTradingStatus trading_status = 2
Статус торговли инструментом.
optional time = 3
Время изменения торгового статуса по UTC.
bool limit_order_available_flag = 4
Признак доступности выставления лимитной заявки по инструменту.
bool market_order_available_flag = 5
Признак доступности выставления рыночной заявки по инструменту.
string instrument_uid = 6
UID инструмента.
Статус трейлинг-стопа.
Used in:
TRAILING_STOP_UNSPECIFIED = 0
Значение не указано.
TRAILING_STOP_ACTIVE = 1
Активный.
TRAILING_STOP_ACTIVATED = 2
Активированный.
Тип параметров значений трейлинг-стопа.
Used in: ,
TRAILING_VALUE_UNSPECIFIED = 0
Значение не указано.
TRAILING_VALUE_ABSOLUTE = 1
Абсолютное значение в единицах цены.
TRAILING_VALUE_RELATIVE = 2
Относительное значение в процентах.
message
users.proto:130Лимит unary-методов.
Used in:
int32 limit_per_minute = 1
Количество unary-запросов в минуту.
repeated string methods = 2
Названия методов.
message
operations.proto:175Used in:
string position_uid = 1
Уникальный идентификатор позиции.
string instrument_uid = 2
Уникальный идентификатор инструмента.
string figi = 3
FIGI-идентификатор инструмента.
string instrument_type = 4
Тип инструмента.
optional quantity = 5
Количество инструмента в портфеле в штуках.
optional average_position_price = 6
Средневзвешенная цена позиции. Для пересчета возможна задержка до одной секунды.
optional expected_yield = 7
Текущая рассчитанная доходность позиции.
optional expected_yield_fifo = 8
Текущая рассчитанная доходность позиции.
optional expire_date = 9
Дата, до которой нужно продать виртуальные бумаги. После этой даты виртуальная позиция «сгораетт».
optional current_price = 10
Текущая цена за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
optional average_position_price_fifo = 11
Средняя цена позиции по методу FIFO. Для пересчета возможна задержка до одной секунды.
optional daily_yield = 31
Рассчитанная доходность портфеля за день.
string ticker = 32
Тикер инструмента.
message
operations.proto:142Запрос доступного остатка для вывода.
Used as request type in: OperationsService.GetWithdrawLimits, SandboxService.GetSandboxWithdrawLimits
string account_id = 1
Идентификатор счета пользователя.
message
operations.proto:147Доступный остаток для вывода.
Used as response type in: OperationsService.GetWithdrawLimits, SandboxService.GetSandboxWithdrawLimits
repeated money = 1
Массив валютных позиций портфеля.
repeated blocked = 2
Массив заблокированных валютных позиций портфеля.
repeated blocked_guarantee = 3
Заблокировано под гарантийное обеспечение фьючерсов.