Deployed fc8d42e with MkDocs version: 1.3.1

RussianInvestments · Dec 6, 2024 · 6fe630b · 6fe630b
1 parent eb521fe
commit 6fe630b
Show file tree

Hide file tree

Showing 18 changed files with 3,749 additions and 3,771 deletions.
diff --git a/contracts/common.proto b/contracts/common.proto
@@ -1,126 +1,133 @@
-syntax = "proto3";
-
-package tinkoff.public.invest.api.contract.v1;
-
-option go_package = "./;investapi";
-option java_package = "ru.tinkoff.piapi.contract.v1";
-option java_multiple_files = true;
-option csharp_namespace = "Tinkoff.InvestApi.V1";
-option objc_class_prefix = "TIAPI";
-option php_namespace = "Tinkoff\\Invest\\V1";
-
-import "google/protobuf/timestamp.proto";
-
-//Тип инструмента.
-enum InstrumentType {
-  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 MoneyValue {
-
-  // Строковый ISO-код валюты.
-  string currency = 1;
-
-  // Целая часть суммы, может быть отрицательным числом.
-  int64 units = 2;
-
-  // Дробная часть суммы, может быть отрицательным числом.
-  int32 nano = 3;
-}
-
-//Котировка — денежная сумма без указания валюты.
-message Quotation {
-
-  // Целая часть суммы, может быть отрицательным числом.
-  int64 units = 1;
-
-  // Дробная часть суммы, может быть отрицательным числом.
-  int32 nano = 2;
-}
-
-//Режим торгов инструмента
-enum SecurityTradingStatus {
-  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 PingRequest {
-  optional google.protobuf.Timestamp time = 1; //Время формирования запроса
-}
-
-message PingDelaySettings {
-  optional int32 ping_delay_ms = 15; //Задержка пинг сообщений milliseconds 5000-180000, default 120000
-}
-
-//Проверка активности стрима.
-message Ping {
-  google.protobuf.Timestamp time = 1; //Время проверки.
-  string stream_id = 2; //Идентификатор соединения.
-  optional google.protobuf.Timestamp ping_request_time = 4; //Время формирования запроса
-}
-
-//Тип цены.
-enum PriceType {
-  PRICE_TYPE_UNSPECIFIED = 0; //Значение не определено.
-  PRICE_TYPE_POINT = 1; //Цена в пунктах (только для фьючерсов и облигаций).
-  PRICE_TYPE_CURRENCY = 2; //Цена в валюте расчётов по инструменту.
-}
-
-message Page {
-  int32 limit = 1; //Максимальное число возвращаемых записей.
-  int32 page_number = 2; //Порядковый номер страницы, начиная с 0.
-}
-
-message PageResponse {
-  int32 limit = 1; //Максимальное число возвращаемых записей.
-  int32 page_number = 2; //Порядковый номер страницы, начиная с 0.
-  int32 total_count = 3; //Общее количество записей.
-}
-
-message ResponseMetadata {
-  string tracking_id = 42; //Идентификатор трекинга.
-  google.protobuf.Timestamp server_time = 43; //Серверное время.
-}
-
-message BrandData {
-  string logo_name = 1; // Логотип инструмента. Имя файла для получения логотипа.
-  string logo_base_color = 2; //	Цвет бренда.
-  string text_color	= 3; // Цвет текста для цвета логотипа бренда.
-}
-
-enum ResultSubscriptionStatus {
-  RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED = 0; //Статус подписки не определен.
-  RESULT_SUBSCRIPTION_STATUS_OK = 1; //Подписка успешно установлена.
-  RESULT_SUBSCRIPTION_STATUS_ERROR = 13; //Ошибка подписки
-}
-
-message ErrorDetail {
-  string code = 1; //Код ошибки.
-  string message = 3; //Описание ошибки.
-}
+syntax = "proto3";
+
+package tinkoff.public.invest.api.contract.v1;
+
+option go_package = "./;investapi";
+option java_package = "ru.tinkoff.piapi.contract.v1";
+option java_multiple_files = true;
+option csharp_namespace = "Tinkoff.InvestApi.V1";
+option objc_class_prefix = "TIAPI";
+option php_namespace = "Tinkoff\\Invest\\V1";
+
+import "google/protobuf/timestamp.proto";
+
+//Тип инструмента.
+enum InstrumentType {
+  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; //Товар.
+}
+
+//Статус запрашиваемых инструментов.
+enum InstrumentStatus {
+  INSTRUMENT_STATUS_UNSPECIFIED = 0; //Значение не определено.
+  INSTRUMENT_STATUS_BASE = 1; //Базовый список инструментов (по умолчанию). Инструменты, доступные для торговли через T-Invest API. Cейчас списки бумаг, которые доступны из API и других интерфейсах совпадают — кроме внебиржевых бумаг. Но в будущем возможны ситуации, когда списки инструментов будут отличаться.
+  INSTRUMENT_STATUS_ALL = 2; //Список всех инструментов.
+}
+
+//Денежная сумма в определённой валюте.
+message MoneyValue {
+
+  // Строковый ISO-код валюты.
+  string currency = 1;
+
+  // Целая часть суммы, может быть отрицательным числом.
+  int64 units = 2;
+
+  // Дробная часть суммы, может быть отрицательным числом.
+  int32 nano = 3;
+}
+
+//Котировка — денежная сумма без указания валюты.
+message Quotation {
+
+  // Целая часть суммы, может быть отрицательным числом.
+  int64 units = 1;
+
+  // Дробная часть суммы, может быть отрицательным числом.
+  int32 nano = 2;
+}
+
+//Режим торгов инструмента
+enum SecurityTradingStatus {
+  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 PingRequest {
+  optional google.protobuf.Timestamp time = 1; //Время формирования запроса
+}
+
+message PingDelaySettings {
+  optional int32 ping_delay_ms = 15; //Задержка пинг сообщений milliseconds 5000-180000, default 120000
+}
+
+//Проверка активности стрима.
+message Ping {
+  google.protobuf.Timestamp time = 1; //Время проверки.
+  string stream_id = 2; //Идентификатор соединения.
+  optional google.protobuf.Timestamp ping_request_time = 4; //Время формирования запроса
+}
+
+//Тип цены.
+enum PriceType {
+  PRICE_TYPE_UNSPECIFIED = 0; //Значение не определено.
+  PRICE_TYPE_POINT = 1; //Цена в пунктах (только для фьючерсов и облигаций).
+  PRICE_TYPE_CURRENCY = 2; //Цена в валюте расчётов по инструменту.
+}
+
+message Page {
+  int32 limit = 1; //Максимальное число возвращаемых записей.
+  int32 page_number = 2; //Порядковый номер страницы, начиная с 0.
+}
+
+message PageResponse {
+  int32 limit = 1; //Максимальное число возвращаемых записей.
+  int32 page_number = 2; //Порядковый номер страницы, начиная с 0.
+  int32 total_count = 3; //Общее количество записей.
+}
+
+message ResponseMetadata {
+  string tracking_id = 42; //Идентификатор трекинга.
+  google.protobuf.Timestamp server_time = 43; //Серверное время.
+}
+
+message BrandData {
+  string logo_name = 1; // Логотип инструмента. Имя файла для получения логотипа.
+  string logo_base_color = 2; //	Цвет бренда.
+  string text_color	= 3; // Цвет текста для цвета логотипа бренда.
+}
+
+enum ResultSubscriptionStatus {
+  RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED = 0; //Статус подписки не определен.
+  RESULT_SUBSCRIPTION_STATUS_OK = 1; //Подписка успешно установлена.
+  RESULT_SUBSCRIPTION_STATUS_ERROR = 13; //Ошибка подписки
+}
+
+message ErrorDetail {
+  string code = 1; //Код ошибки.
+  string message = 3; //Описание ошибки.
+}