Skip to content

Commit

Permalink
Deployed f36bf82 with MkDocs version: 1.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
p977ac committed Mar 12, 2024
1 parent bae19e8 commit e90cf93
Show file tree
Hide file tree
Showing 16 changed files with 309 additions and 112 deletions.
40 changes: 27 additions & 13 deletions contracts/marketdata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import "google/protobuf/timestamp.proto";
import "common.proto";
import "google/api/field_behavior.proto";

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

//Метод запроса исторических свечей по инструменту.
rpc GetCandles(GetCandlesRequest) returns (GetCandlesResponse);
Expand All @@ -36,6 +36,7 @@ service MarketDataService { //Сервис получения биржевой
//Метод запроса цен закрытия торговой сессии по инструментам.
rpc GetClosePrices(GetClosePricesRequest) returns (GetClosePricesResponse);

//Метод получения технических индикаторов по инструменту
rpc GetTechAnalysis(GetTechAnalysisRequest) returns (GetTechAnalysisResponse);
}

Expand Down Expand Up @@ -118,7 +119,7 @@ enum SubscriptionInterval {

//Запрос изменения статус подписки на свечи.
message CandleInstrument {
string figi = 1 [ deprecated = true ]; // Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string figi = 1 [deprecated = true]; // Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
SubscriptionInterval interval = 2; //Интервал свечей. (Двухчасовые и четырехчасовые свечи в стриме отсчитываются с 0:00 по UTC)
string instrument_id = 3; //Идентификатор инструмента, принимает значение figi или instrument_uid
}
Expand Down Expand Up @@ -162,7 +163,7 @@ message SubscribeOrderBookRequest {

//Запрос подписки на стаканы.
message OrderBookInstrument {
string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
int32 depth = 2; //Глубина стакана.
string instrument_id = 3; //Идентификатор инструмента, принимает значение figi или instrument_uid
OrderBookType order_book_type = 4; //Тип стакана
Expand Down Expand Up @@ -193,7 +194,7 @@ message SubscribeTradesRequest {

//Запрос подписки на поток обезличенных сделок.
message TradeInstrument {
string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string instrument_id = 2; //Идентификатор инструмента, принимает значение figi или instrument_uid
}

Expand All @@ -220,7 +221,7 @@ message SubscribeInfoRequest {

//Запрос подписки на торговый статус.
message InfoInstrument {
string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string instrument_id = 2; //Идентификатор инструмента, принимает значение figi или instrument_uid
}

Expand All @@ -247,7 +248,7 @@ message SubscribeLastPriceRequest {

//Запрос подписки на последнюю цену.
message LastPriceInstrument {
string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
string instrument_id = 2; //Идентификатор инструмента, принимает значение figi или instrument_uid
}

Expand Down Expand Up @@ -329,11 +330,17 @@ message TradingStatus {

//Запрос исторических свечей.
message GetCandlesRequest {
optional string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
optional string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
google.protobuf.Timestamp from = 2 [(google.api.field_behavior) = REQUIRED]; //Начало запрашиваемого периода в часовом поясе UTC.
google.protobuf.Timestamp to = 3 [(google.api.field_behavior) = REQUIRED]; //Окончание запрашиваемого периода в часовом поясе UTC.
CandleInterval interval = 4 [(google.api.field_behavior) = REQUIRED]; //Интервал запрошенных свечей.
optional string instrument_id = 5; //Идентификатор инструмента, принимает значение figi или instrument_uid.
optional CandleSource candle_source_type = 7; //Тип источника свечи

enum CandleSource {
CANDLE_SOURCE_UNSPECIFIED = 0; //Все свечи.
CANDLE_SOURCE_EXCHANGE = 1; //Биржевые свечи.
}
}

//Интервал свечей.
Expand All @@ -354,6 +361,12 @@ enum CandleInterval {
CANDLE_INTERVAL_MONTH = 13; //от 1 месяца до 10 лет.
}

enum CandleSource {
CANDLE_SOURCE_UNSPECIFIED = 0; //Источник свечей не определён.
CANDLE_SOURCE_EXCHANGE = 1; //Биржевые свечи.
CANDLE_SOURCE_DEALER_WEEKEND = 2; //Свечи дилера в результате торговли по выходным.
}

//Список свечей.
message GetCandlesResponse {
repeated HistoricCandle candles = 1; //Массив свечей.
Expand All @@ -368,11 +381,12 @@ message HistoricCandle {
int64 volume = 5; //Объём торгов в лотах.
google.protobuf.Timestamp time = 6; //Время свечи в часовом поясе UTC.
bool is_complete = 7; //Признак завершённости свечи. **false** значит, свеча за текущие интервал ещё сформирована не полностью.
CandleSource candle_source = 9; //Тип источника свечи
}

//Запрос получения цен последних сделок.
message GetLastPricesRequest {
repeated string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
repeated string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
repeated string instrument_id = 2; //Массив идентификаторов инструмента, принимает значения figi или instrument_uid.
}

Expand All @@ -391,7 +405,7 @@ message LastPrice {

//Запрос стакана.
message GetOrderBookRequest {
optional string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
optional string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
int32 depth = 2 [(google.api.field_behavior) = REQUIRED]; //Глубина стакана.
optional string instrument_id = 3; //Идентификатор инструмента, принимает значение figi или instrument_uid.
}
Expand All @@ -414,7 +428,7 @@ message GetOrderBookResponse {

//Запрос получения торгового статуса.
message GetTradingStatusRequest {
optional string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
optional string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
optional string instrument_id = 2; //Идентификатор инструмента, принимает значение figi или instrument_uid.
}

Expand Down Expand Up @@ -443,7 +457,7 @@ message GetTradingStatusResponse {

//Запрос обезличенных сделок за последний час.
message GetLastTradesRequest {
optional string figi = 1 [ deprecated = true ]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
optional string figi = 1 [deprecated = true]; //Deprecated Figi-идентификатор инструмента. Необходимо использовать instrument_id.
google.protobuf.Timestamp from = 2 [(google.api.field_behavior) = REQUIRED]; //Начало запрашиваемого периода в часовом поясе UTC.
google.protobuf.Timestamp to = 3 [(google.api.field_behavior) = REQUIRED]; //Окончание запрашиваемого периода в часовом поясе UTC.
optional string instrument_id = 4; //Идентификатор инструмента, принимает значение figi или instrument_uid.
Expand All @@ -455,7 +469,7 @@ message GetLastTradesResponse {
}

//Запрос активных подписок.
message GetMySubscriptions { }
message GetMySubscriptions {}

//Запрос цен закрытия торговой сессии по инструментам.
message GetClosePricesRequest {
Expand Down Expand Up @@ -556,4 +570,4 @@ enum OrderBookType {
ORDERBOOK_TYPE_UNSPECIFIED = 0; //не определен
ORDERBOOK_TYPE_EXCHANGE = 1; //Биржевой стакан
ORDERBOOK_TYPE_DEALER = 2; //Стакан дилера
}
}
2 changes: 1 addition & 1 deletion contracts/sandbox.proto
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ service SandboxService { //Сервис для работы с песочниц

//Запрос открытия счёта в песочнице.
message OpenSandboxAccountRequest {
//пустой запрос
optional string name = 1; // Название счёта
}

//Номер открытого счёта в песочнице.
Expand Down
10 changes: 10 additions & 0 deletions errors/api_errors.json
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,16 @@
"type": "INVALID_ARGUMENT",
"description": "Количество инструментов в списке не может быть больше 3000."
},
"30219": {
"message": "input candle_source_type is invalid",
"type": "INVALID_ARGUMENT",
"description": "Проверьте параметры запроса. Некорректный параметр candle_source_type."
},
"35001": {
"message": "sandbox accounts limit reached",
"type": "INVALID_ARGUMENT",
"description": "Достигнут лимит на открытие торговых счетов в песочнице. Чтобы открыть новый счет необходимо закрыть один из существующих"
},
"40002": {
"message": "insufficient privileges",
"type": "PERMISSION_DENIED",
Expand Down
12 changes: 12 additions & 0 deletions errors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2052,6 +2052,18 @@ <h1 id="tinkoff-invest-api">Ошибки TINKOFF INVEST API</h1>
<td>Количество инструментов в списке не может быть больше 3000.</td>
</tr>
<tr>
<td>30219</td>
<td>INVALID_ARGUMENT</td>
<td>input candle_source_type is invalid</td>
<td>Проверьте параметры запроса. Некорректный параметр candle_source_type.</td>
</tr>
<tr>
<td>35001</td>
<td>INVALID_ARGUMENT</td>
<td>sandbox accounts limit reached</td>
<td>Достигнут лимит на открытие торговых счетов в песочнице. Чтобы открыть новый счет необходимо закрыть один из существующих</td>
</tr>
<tr>
<td>40002</td>
<td>PERMISSION_DENIED</td>
<td>insufficient privileges</td>
Expand Down
3 changes: 2 additions & 1 deletion faq_marketdata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2138,7 +2138,8 @@ <h3 id="_22">Какие данные отливаются в стриминг с
<p>Пока только биржевые. Внебиржевые стаканы, например, TRRE, не транслируются в режиме стриминга.</p>
<h3 id="tinkoff-invest-api_5">Торговля бумагами Тинькофф через TINKOFF INVEST API<a id="2.10"></a></h3>
<p>Из-за огромного количества скальперских сделок мы закрыли торговлю БПИФ от УК "Тинькофф Капитал" в TINKOFF INVEST API.
Список бумаг смотрите <a href="https://russianinvestments.github.io/invest-openapi/">здесь</a>.</p>
Однако есть несколько фондов, доступных для торговли. Определить их можно по двум признакам:
<a href="/investAPI/head-instruments/#api">доступность инстумента в API</a> и <a href="/investAPI/faq_trading_status/">торговый статус</a> <code>NORMAL_TRADING</code>.</p>
<h3 id="tinkoff-invest-api_6">Валюты в TINKOFF INVEST API<a id="2.11"></a></h3>
<p>Получить список доступных валют можно при помощи метода <a href="/investAPI/instruments#currencies">getInstruments/currencies</a>.</p>
<p>Обратите внимание, что лотность валют ограничена лотностью, которая предоставляет биржа. Например, операции
Expand Down
10 changes: 5 additions & 5 deletions head-instruments/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -880,7 +880,7 @@

<li class="md-nav__item">
<a href="#_5" class="md-nav__link">
Получения размера гарантийного обеспечения по фьючерсу
Получения размера гарантийного обеспечения (ГО) по фьючерсу
</a>

</li>
Expand Down Expand Up @@ -1570,7 +1570,7 @@

<li class="md-nav__item">
<a href="#_5" class="md-nav__link">
Получения размера гарантийного обеспечения по фьючерсу
Получения размера гарантийного обеспечения (ГО) по фьючерсу
</a>

</li>
Expand Down Expand Up @@ -1757,14 +1757,14 @@ <h2 id="_4">Получение расписания выплаты купоно
<p>Операции по регулярным выплатам процентов по облигации называются купонами. Для получения графика таких
выплат используется метод <a href="/investAPI/instruments#getaccruedinterests">getAccruedInterests</a>. Метод позволяет получить график выплаты купонов
для запрошенного периода времени.</p>
<h2 id="_5">Получения размера гарантийного обеспечения по фьючерсу</h2>
<h2 id="_5">Получения размера гарантийного обеспечения (ГО) по фьючерсу</h2>
<p>Фьючерс — это договор между покупателем и продавцом о поставке базового актива в будущем или о выплате
одной из сторон другой стороне разницы между стоимостью контракта и стоимостью базового актива в
будущем (<a href="https://help.tinkoff.ru/forts/">Срочный рынок</a>).</p>
<p>Для операций с фьючерсами брокером "замораживается" определённый размер гарантийного обеспечения на счёте
пользователя. Для получения информации о размере этого обеспечения используется метод <a href="/investAPI/instruments#getfuturesmargin">getFuturesMargin</a>.
Обратите внимание, что размер гарантийного обеспечения может отличаться для операций покупки и продажи
фьючерса.</p>
<strong>Важно!!!</strong> Метод возвращает ориентировочное значение средств к блокировке, рассчитанное биржей.
Это значение не является конечным резервируемым объемом ГО, после заключения сделки заблокированная сумма может отличаться.</p>
<h2 id="_6">Получение и изменение списка избранных инструментов</h2>
<p>Используя метод <a href="/investAPI/instruments#getfavorites">GetFavorites</a> можно получить список избранных инструментов клиента.
Данный метод может использоваться разработчиками для получения списка инструментов, которые робот добавил в избранное используя метод <a href="/investAPI/instruments#editfavorites">EditFavorites</a>.</p>
Expand Down
Loading

0 comments on commit e90cf93

Please sign in to comment.