package tinkoff.public.invest.api.contract.v1

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service InstrumentsService

instruments.proto:16

Сервис предназначен для получения:</br>**1**. информации об инструментах;</br>**2**. расписания торговых сессий;</br>**3**. календаря выплат купонов по облигациям;</br>**4**. размера гарантийного обеспечения по фьючерсам;</br>**5**. дивидендов по ценной бумаге.

service MarketDataService

marketdata.proto:15

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

service MarketDataStreamService

marketdata.proto:33

service OperationsService

operations.proto:15

Сервис предназначен для получения:</br> **1**. списка операций по счёту;</br> **2**. портфеля по счёту;</br> **3**. позиций ценных бумаг на счёте;</br> **4**. доступного остатка для вывода средств;</br> **4**. получения различных отчётов.

service OrdersService

orders.proto:20

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

service OrdersStreamService

orders.proto:15

service SandboxService

sandbox.proto:17

Сервис для работы с песочницей TINKOFF INVEST API

service StopOrdersService

stoporders.proto:15

Сервис предназначен для работы со стоп-заявками:</br> **1**. выставление;</br> **2**. отмена;</br> **3**. получение списка стоп-заявок.

service UsersService

users.proto:15

Сервис предназначен для получения: </br> **1**. списка счетов пользователя; </br> **2**. маржинальных показателе по счёту.

enum AccessLevel

users.proto:142

Уровень доступа к счёту.

Used in: Account

message Account

users.proto:41

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

Used in: GetAccountsResponse

enum AccountStatus

users.proto:74

Статус счёта.

Used in: Account

enum AccountType

users.proto:66

Тип счёта.

Used in: Account

message AccruedInterest

instruments.proto:435

Операция начисления купонов.

Used in: GetAccruedInterestsResponse

message Asset

instruments.proto:591

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

Used in: AssetsResponse

message AssetBond

instruments.proto:645

Облигация.

Used in: AssetSecurity

message AssetClearingCertificate

instruments.proto:729

Клиринговый сертификат участия.

Used in: AssetSecurity

message AssetCurrency

instruments.proto:608

Валюта.

Used in: AssetFull

message AssetEtf

instruments.proto:694

Фонд.

Used in: AssetSecurity

message AssetFull

instruments.proto:567

Used in: AssetResponse

message AssetInstrument

instruments.proto:747

Идентификаторы инструмента.

Used in: Asset, AssetFull

message AssetSecurity

instruments.proto:613

Ценная бумага.

Used in: AssetFull

message AssetShare

instruments.proto:626

Акция.

Used in: AssetSecurity

message AssetStructuredProduct

instruments.proto:670

Структурная нота.

Used in: AssetSecurity

enum AssetType

instruments.proto:599

Тип актива.

Used in: Asset, AssetFull, AssetStructuredProduct

message Bond

instruments.proto:217

Объект передачи информации об облигации.

Used in: BondResponse, BondsResponse

message Brand

instruments.proto:735

Бренд.

Used in: AssetFull

message BrokerReport

operations.proto:183

Used in: GetBrokerReportResponse

message CancelOrderRequest

orders.proto:100

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

Used as request type in: OrdersService.CancelOrder, SandboxService.CancelSandboxOrder

message CancelOrderResponse

orders.proto:106

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

Used as response type in: OrdersService.CancelOrder, SandboxService.CancelSandboxOrder

message Candle

marketdata.proto:212

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

Used in: MarketDataResponse

message CandleInstrument

marketdata.proto:87

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

Used in: SubscribeCandlesRequest

enum CandleInterval

marketdata.proto:276

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

Used in: GetCandlesRequest

message CandleSubscription

marketdata.proto:99

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

Used in: SubscribeCandlesResponse

message Coupon

instruments.proto:152

Объект передачи информации о купоне облигации.

Used in: GetBondCouponsResponse

enum CouponType

instruments.proto:165

Тип купонов.

Used in: Coupon

message Currency

instruments.proto:265

Объект передачи информации о валюте.

Used in: CurrenciesResponse, CurrencyResponse

message Dividend

instruments.proto:522

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

Used in: GetDividendsResponse

message DividendsForeignIssuerReport

operations.proto:309

Отчёт "Справка о доходах за пределами РФ".

Used in: GetDividendsForeignIssuerReportResponse

enum EditFavoritesActionType

instruments.proto:794

Тип действия со списком избранных инструментов.

Used in: EditFavoritesRequest

message EditFavoritesRequestInstrument

instruments.proto:789

Избранный инструмент для редактирования.

Used in: EditFavoritesRequest

message Etf

instruments.proto:301

Объект передачи информации об инвестиционном фонде.

Used in: EtfResponse, EtfsResponse

message FavoriteInstrument

instruments.proto:772

Избранный инструмент.

Used in: EditFavoritesResponse, GetFavoritesResponse

message Future

instruments.proto:341

Объект передачи информации о фьючерсе.

Used in: FutureResponse, FuturesResponse

message GenerateBrokerReportRequest

operations.proto:161

Used in: BrokerReportRequest

message GenerateBrokerReportResponse

operations.proto:167

Used in: BrokerReportResponse

message GenerateDividendsForeignIssuerReportRequest

operations.proto:284

Объект запроса формирования отчёта "Справка о доходах за пределами РФ".

Used in: GetDividendsForeignIssuerRequest

message GenerateDividendsForeignIssuerReportResponse

operations.proto:297

Объект результата задачи запуска формирования отчёта "Справка о доходах за пределами РФ".

Used in: GetDividendsForeignIssuerResponse

message GetAccountsRequest

users.proto:32

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

Used as request type in: SandboxService.GetSandboxAccounts, UsersService.GetAccounts

(message has no fields)

message GetAccountsResponse

users.proto:35

Список счетов пользователя.

Used as response type in: SandboxService.GetSandboxAccounts, UsersService.GetAccounts

message GetBrokerReportRequest

operations.proto:171

Used in: BrokerReportRequest

message GetBrokerReportResponse

operations.proto:176

Used in: BrokerReportResponse

message GetDividendsForeignIssuerReportRequest

operations.proto:291

Объект запроса сформированного отчёта "Справка о доходах за пределами РФ".

Used in: GetDividendsForeignIssuerRequest

message GetDividendsForeignIssuerReportResponse

operations.proto:301

Used in: GetDividendsForeignIssuerResponse

message GetOrderStateRequest

orders.proto:111

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

Used as request type in: OrdersService.GetOrderState, SandboxService.GetSandboxOrderState

message GetOrdersRequest

orders.proto:117

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

Used as request type in: OrdersService.GetOrders, SandboxService.GetSandboxOrders

message GetOrdersResponse

orders.proto:122

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

Used as response type in: OrdersService.GetOrders, SandboxService.GetSandboxOrders

message HistoricCandle

marketdata.proto:291

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

Used in: GetCandlesResponse

message InfoInstrument

marketdata.proto:172

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

Used in: SubscribeInfoRequest

message InfoSubscription

marketdata.proto:183

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

Used in: SubscribeInfoResponse

message Instrument

instruments.proto:476

Объект передачи основной информации об инструменте.

Used in: InstrumentResponse

enum InstrumentIdType

instruments.proto:456

Тип идентификатора инструмента. Подробнее об идентификации инструментов: [Идентификация инструментов](https://tinkoff.github.io/investAPI/faq_identification/)

Used in: InstrumentRequest

Связь с другим инструментом.

Used in: AssetInstrument

message InstrumentRequest

instruments.proto:118

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

Used as request type in: InstrumentsService.BondBy, InstrumentsService.CurrencyBy, InstrumentsService.EtfBy, InstrumentsService.FutureBy, InstrumentsService.GetInstrumentBy, InstrumentsService.ShareBy

enum InstrumentStatus

instruments.proto:464

Статус запрашиваемых инструментов.

Used in: InstrumentsRequest

message InstrumentsRequest

instruments.proto:125

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

Used as request type in: InstrumentsService.Bonds, InstrumentsService.Currencies, InstrumentsService.Etfs, InstrumentsService.Futures, InstrumentsService.Shares

message LastPrice

marketdata.proto:312

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

Used in: GetLastPricesResponse, MarketDataResponse

message LastPriceInstrument

marketdata.proto:195

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

Used in: SubscribeLastPriceRequest

message LastPriceSubscription

marketdata.proto:206

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

Used in: SubscribeLastPriceResponse

message MoneyValue

common.proto:15

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

Used in: Bond, BrokerReport, Coupon, Currency, Dividend, GetFuturesMarginResponse, GetMarginAttributesResponse, Operation, OperationTrade, OrderStage, OrderState, PortfolioPosition, PortfolioResponse, PositionsResponse, PostOrderResponse, SandboxPayInRequest, SandboxPayInResponse, Share, StopOrder, WithdrawLimitsResponse

message Operation

operations.proto:52

Данные по операции.

Used in: OperationsResponse

enum OperationState

operations.proto:214

Статус запрашиваемых операций.

Used in: Operation, OperationsRequest

message OperationTrade

operations.proto:70

Сделка по операции.

Used in: Operation

enum OperationType

operations.proto:221

Тип операции.

Used in: Operation

message OperationsRequest

operations.proto:38

Запрос получения списка операций по счёту.

Used as request type in: OperationsService.GetOperations, SandboxService.GetSandboxOperations

message OperationsResponse

operations.proto:47

Список операций.

Used as response type in: OperationsService.GetOperations, SandboxService.GetSandboxOperations

message Order

marketdata.proto:237

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

Used in: GetOrderBookResponse, OrderBook

message OrderBook

marketdata.proto:225

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

Used in: MarketDataResponse

message OrderBookInstrument

marketdata.proto:124

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

Used in: SubscribeOrderBookRequest

message OrderBookSubscription

marketdata.proto:136

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

Used in: SubscribeOrderBookResponse

enum OrderDirection

orders.proto:156

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

Used in: OrderState, OrderTrades, PostOrderRequest, PostOrderResponse

enum OrderExecutionReportStatus

orders.proto:170

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

Used in: OrderState, PostOrderResponse

message OrderStage

orders.proto:149

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

Used in: OrderState

message OrderState

orders.proto:127

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

Used as response type in: OrdersService.GetOrderState, SandboxService.GetSandboxOrderState

Used as field type in: GetOrdersResponse

message OrderTrade

orders.proto:60

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

Used in: OrderTrades

message OrderTrades

orders.proto:50

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

Used in: TradesStreamResponse

enum OrderType

orders.proto:163

Тип заявки

Used in: OrderState, PostOrderRequest, PostOrderResponse

message Ping

common.proto:59

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

Used in: MarketDataResponse, TradesStreamResponse

message PortfolioPosition

operations.proto:120

Позиции портфеля.

Used in: PortfolioResponse

message PortfolioRequest

operations.proto:78

Запрос получения текущего портфеля по счёту.

Used as request type in: OperationsService.GetPortfolio, SandboxService.GetSandboxPortfolio

message PortfolioResponse

operations.proto:83

Текущий портфель по счёту.

Used as response type in: OperationsService.GetPortfolio, SandboxService.GetSandboxPortfolio

message PositionsFutures

operations.proto:141

Баланс фьючерса.

Used in: PositionsResponse

message PositionsRequest

operations.proto:94

Запрос позиций портфеля по счёту.

Used as request type in: OperationsService.GetPositions, SandboxService.GetSandboxPositions

message PositionsResponse

operations.proto:99

Список позиций по счёту.

Used as response type in: OperationsService.GetPositions, SandboxService.GetSandboxPositions

message PositionsSecurities

operations.proto:134

Баланс позиции ценной бумаги.

Used in: PositionsResponse

message PostOrderRequest

orders.proto:67

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

Used as request type in: OrdersService.PostOrder, SandboxService.PostSandboxOrder

message PostOrderResponse

orders.proto:78

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

Used as response type in: OrdersService.PostOrder, SandboxService.PostSandboxOrder

message Quotation

common.proto:28

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

Used in: AccruedInterest, AssetBond, AssetClearingCertificate, AssetEtf, AssetShare, AssetStructuredProduct, Bond, BrokerReport, Candle, Currency, Dividend, DividendsForeignIssuerReport, Etf, Future, GetFuturesMarginResponse, GetMarginAttributesResponse, GetOrderBookResponse, HistoricCandle, Instrument, LastPrice, Order, OrderBook, OrderTrade, PortfolioPosition, PortfolioResponse, PostOrderRequest, PostOrderResponse, PostStopOrderRequest, Share, Trade

enum RealExchange

instruments.proto:806

Реальная площадка исполнения расчётов.

Used in: Bond, Currency, Etf, Future, Instrument, Share

enum SecurityTradingStatus

common.proto:38

Режим торгов инструмента

Used in: Bond, Currency, Etf, Future, GetTradingStatusResponse, Instrument, Share, TradingStatus

message Share

instruments.proto:382

Объект передачи информации об акции.

Used in: ShareResponse, SharesResponse

enum ShareType

instruments.proto:536

Тип акций.

Used in: AssetShare, Share

message StopOrder

stoporders.proto:68

Информация о стоп-заявке.

Used in: GetStopOrdersResponse

enum StopOrderDirection

stoporders.proto:83

Направление сделки стоп-заявки.

Used in: PostStopOrderRequest, StopOrder

enum StopOrderExpirationType

stoporders.proto:90

Тип экспирации стоп-заявке.

Used in: PostStopOrderRequest

enum StopOrderType

stoporders.proto:97

Тип стоп-заявки.

Used in: PostStopOrderRequest, StopOrder

message StreamLimit

users.proto:124

Лимит stream-соединений.

Used in: GetUserTariffResponse

enum StructuredProductType

instruments.proto:687

Тип структурной ноты.

Used in: AssetStructuredProduct

message SubscribeCandlesRequest

marketdata.proto:67

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

Used in: MarketDataRequest

message SubscribeCandlesResponse

marketdata.proto:93

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

Used in: MarketDataResponse

message SubscribeInfoRequest

marketdata.proto:166

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

Used in: MarketDataRequest

message SubscribeInfoResponse

marketdata.proto:177

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

Used in: MarketDataResponse

message SubscribeLastPriceRequest

marketdata.proto:189

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

Used in: MarketDataRequest

message SubscribeLastPriceResponse

marketdata.proto:200

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

Used in: MarketDataResponse

message SubscribeOrderBookRequest

marketdata.proto:118

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

Used in: MarketDataRequest

message SubscribeOrderBookResponse

marketdata.proto:130

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

Used in: MarketDataResponse

message SubscribeTradesRequest

marketdata.proto:143

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

Used in: MarketDataRequest

message SubscribeTradesResponse

marketdata.proto:154

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

Used in: MarketDataResponse

enum SubscriptionAction

marketdata.proto:73

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

Used in: SubscribeCandlesRequest, SubscribeInfoRequest, SubscribeLastPriceRequest, SubscribeOrderBookRequest, SubscribeTradesRequest

enum SubscriptionInterval

marketdata.proto:80

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

Used in: Candle, CandleInstrument, CandleSubscription

enum SubscriptionStatus

marketdata.proto:106

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

Used in: CandleSubscription, InfoSubscription, LastPriceSubscription, OrderBookSubscription, TradeSubscription

message Trade

marketdata.proto:243

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

Used in: GetLastTradesResponse, MarketDataResponse

enum TradeDirection

marketdata.proto:252

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

Used in: Trade

message TradeInstrument

marketdata.proto:149

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

Used in: SubscribeTradesRequest

message TradeSubscription

marketdata.proto:160

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

Used in: SubscribeTradesResponse

message TradingDay

instruments.proto:100

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

Used in: TradingSchedule

message TradingSchedule

instruments.proto:94

Данные по торговой площадке.

Used in: TradingSchedulesResponse

message TradingStatus

marketdata.proto:259

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

Used in: MarketDataResponse

message UnaryLimit

users.proto:118

Лимит unary-методов.

Used in: GetUserTariffResponse