yatis 0.2.1

Yet Another T-bank Investment Sdk
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311







## StopOrdersService
Сервис для работы со стоп-заявками: выставление, отмена, получение списка стоп-заявок.

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


#### PostStopOrder
Выставить стоп-заявку.

- Тело запроса — [PostStopOrderRequest](#poststoporderrequest)

- Тело ответа — [PostStopOrderResponse](#poststoporderresponse)


#### GetStopOrders
Получить список активных стоп-заявок по счету.

- Тело запроса — [GetStopOrdersRequest](#getstopordersrequest)

- Тело ответа — [GetStopOrdersResponse](#getstopordersresponse)


#### CancelStopOrder
Отменить стоп-заявку.

- Тело запроса — [CancelStopOrderRequest](#cancelstoporderrequest)

- Тело ответа — [CancelStopOrderResponse](#cancelstoporderresponse)

 <!-- range .Methods -->
 <!-- range .Services -->

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



#### PostStopOrderRequest
Запрос выставления стоп-заявки.


| Field | Type | Description |
| ----- | ---- | ----------- |
| figi |  [string](#string) | Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`. |
| quantity |  [int64](#int64) | Количество лотов. |
| price |  [Quotation](#quotation) | Цена за 1 инструмент биржевой заявки, которая будет выставлена при срабатывании по достижению `stop_price`. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. |
| stop_price |  [Quotation](#quotation) | Стоп-цена заявки за 1 инструмент. При достижении стоп-цены происходит активация стоп-заявки, в результате чего выставляется биржевая заявка. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. |
| direction |  [StopOrderDirection](#stoporderdirection) | Направление операции. |
| account_id |  [string](#string) | Номер счета. |
| expiration_type |  [StopOrderExpirationType](#stoporderexpirationtype) | Тип экспирации заявки. |
| stop_order_type |  [StopOrderType](#stopordertype) | Тип заявки. |
| expire_date |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Дата и время окончания действия стоп-заявки по UTC. Для `ExpirationType = GoodTillDate` заполнение обязательно, для `GoodTillCancel` игнорируется. |
| instrument_id |  [string](#string) | Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`. |
| exchange_order_type |  [ExchangeOrderType](#exchangeordertype) | Тип дочерней биржевой заявки. |
| take_profit_type |  [TakeProfitType](#takeprofittype) | Подтип стоп-заявки — `TakeProfit`. |
| trailing_data |  [PostStopOrderRequest.TrailingData](#poststoporderrequesttrailingdata) | Массив с параметрами трейлинг-стопа. |
| price_type |  [PriceType](#pricetype) | Тип цены. |
| order_id |  [string](#string) | Идентификатор запроса выставления поручения для целей идемпотентности в формате `UID`. Максимальная длина — 36 символов. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### PostStopOrderRequest.TrailingData



| Field | Type | Description |
| ----- | ---- | ----------- |
| indent |  [Quotation](#quotation) | Отступ. |
| indent_type |  [TrailingValueType](#trailingvaluetype) | Тип величины отступа. |
| spread |  [Quotation](#quotation) | Размер защитного спреда. |
| spread_type |  [TrailingValueType](#trailingvaluetype) | Тип величины защитного спреда. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### PostStopOrderResponse
Результат выставления стоп-заявки.


| Field | Type | Description |
| ----- | ---- | ----------- |
| stop_order_id |  [string](#string) | Уникальный идентификатор стоп-заявки. |
| order_request_id |  [string](#string) | Идентификатор ключа идемпотентности, переданный клиентом, в формате `UID`. Максимальная длина 36 — символов. |
| response_metadata |  [ResponseMetadata](#responsemetadata) | Метадата. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### GetStopOrdersRequest
Запрос получения списка активных стоп-заявок.


| Field | Type | Description |
| ----- | ---- | ----------- |
| account_id |  [string](#string) | Идентификатор счета клиента. |
| status |  [StopOrderStatusOption](#stoporderstatusoption) | Статус заявок. |
| from |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Левая граница. |
| to |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Правая граница. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### GetStopOrdersResponse
Список активных стоп-заявок.


| Field | Type | Description |
| ----- | ---- | ----------- |
| stop_orders | Массив объектов [StopOrder](#stoporder) | Массив стоп-заявок по счету. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### CancelStopOrderRequest
Запрос отмены выставленной стоп-заявки.


| Field | Type | Description |
| ----- | ---- | ----------- |
| account_id |  [string](#string) | Идентификатор счета клиента. |
| stop_order_id |  [string](#string) | Уникальный идентификатор стоп-заявки. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### CancelStopOrderResponse
Результат отмены выставленной стоп-заявки.


| Field | Type | Description |
| ----- | ---- | ----------- |
| time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Время отмены заявки по UTC. |
 <!-- end Fields -->
 <!-- end HasFields -->


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


| Field | Type | Description |
| ----- | ---- | ----------- |
| stop_order_id |  [string](#string) | Уникальный идентификатор стоп-заявки. |
| lots_requested |  [int64](#int64) | Запрошено лотов. |
| figi |  [string](#string) | FIGI-идентификатор инструмента. |
| direction |  [StopOrderDirection](#stoporderdirection) | Направление операции. |
| currency |  [string](#string) | Валюта стоп-заявки. |
| order_type |  [StopOrderType](#stopordertype) | Тип стоп-заявки. |
| create_date |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Дата и время выставления заявки по UTC. |
| activation_date_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Дата и время конвертации стоп-заявки в биржевую по UTC. |
| expiration_time |  [google.protobuf.Timestamp](#googleprotobuftimestamp) | Дата и время снятия заявки по UTC. |
| price |  [MoneyValue](#moneyvalue) | Цена заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. |
| stop_price |  [MoneyValue](#moneyvalue) | Цена активации стоп-заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента. |
| instrument_uid |  [string](#string) | `instrument_uid`-идентификатор инструмента. |
| take_profit_type |  [TakeProfitType](#takeprofittype) | Подтип стоп-заявки — `TakeProfit`. |
| trailing_data |  [StopOrder.TrailingData](#stopordertrailingdata) | Параметры трейлинг-стопа. |
| status |  [StopOrderStatusOption](#stoporderstatusoption) | Статус заявки. |
| exchange_order_type |  [ExchangeOrderType](#exchangeordertype) | Тип дочерней биржевой заявки для тейкпрофита. |
| exchange_order_id |  [string](#string) | Идентификатор биржевой заявки. |
 <!-- end Fields -->
 <!-- end HasFields -->


#### StopOrder.TrailingData



| Field | Type | Description |
| ----- | ---- | ----------- |
| indent |  [Quotation](#quotation) | Отступ. |
| indent_type |  [TrailingValueType](#trailingvaluetype) | Тип величины отступа. |
| spread |  [Quotation](#quotation) | Размер защитного спреда. |
| spread_type |  [TrailingValueType](#trailingvaluetype) | Тип величины защитного спреда. |
| status |  [TrailingStopStatus](#trailingstopstatus) | Статус трейлинг-стопа. |
| price |  [Quotation](#quotation) | Цена исполнения. |
| extr |  [Quotation](#quotation) | Локальный экстремум. |
 <!-- end Fields -->
 <!-- end HasFields -->
 <!-- end messages -->

### Enums


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

| Name | Number | Description |
| ---- | ------ | ----------- |
| STOP_ORDER_DIRECTION_UNSPECIFIED | 0 | Значение не указано. |
| STOP_ORDER_DIRECTION_BUY | 1 | Покупка. |
| STOP_ORDER_DIRECTION_SELL | 2 | Продажа. |




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

| Name | Number | Description |
| ---- | ------ | ----------- |
| STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED | 0 | Значение не указано. |
| STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL | 1 | Действительно до отмены. |
| STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE | 2 | Действительно до даты снятия. |




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

| Name | Number | Description |
| ---- | ------ | ----------- |
| 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`-заявка. |




#### StopOrderStatusOption
Статус стоп-заяки.

| Name | Number | Description |
| ---- | ------ | ----------- |
| 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 | Истекшие заявки. |




#### ExchangeOrderType
Тип выставляемой заявки.

| Name | Number | Description |
| ---- | ------ | ----------- |
| EXCHANGE_ORDER_TYPE_UNSPECIFIED | 0 | Значение не указано. |
| EXCHANGE_ORDER_TYPE_MARKET | 1 | Заявка по рыночной цене. |
| EXCHANGE_ORDER_TYPE_LIMIT | 2 | Лимитная заявка. |




#### TakeProfitType
Тип TakeProfit-заявки.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TAKE_PROFIT_TYPE_UNSPECIFIED | 0 | Значение не указано. |
| TAKE_PROFIT_TYPE_REGULAR | 1 | Обычная заявка, значение по умолчанию. |
| TAKE_PROFIT_TYPE_TRAILING | 2 | Трейлинг-стоп. |




#### TrailingValueType
Тип параметров значений трейлинг-стопа.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TRAILING_VALUE_UNSPECIFIED | 0 | Значение не указано. |
| TRAILING_VALUE_ABSOLUTE | 1 | Абсолютное значение в единицах цены. |
| TRAILING_VALUE_RELATIVE | 2 | Относительное значение в процентах. |




#### TrailingStopStatus
Статус трейлинг-стопа.

| Name | Number | Description |
| ---- | ------ | ----------- |
| TRAILING_STOP_UNSPECIFIED | 0 | Значение не указано. |
| TRAILING_STOP_ACTIVE | 1 | Активный. |
| TRAILING_STOP_ACTIVATED | 2 | Активированный. |


 <!-- range .Enums -->
 <!-- range HasServices -->
 <!-- range .Files -->

### Нестандартные типы данных

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

| Field | Type | Description |
| ----- | ---- | ----------- |
| currency |  [string](#string) | Строковый ISO-код валюты |
| units |  [int64](#int64) | Целая часть суммы, может быть отрицательным числом |
| nano |  [int32](#int32) | Дробная часть суммы, может быть отрицательным числом |


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

| Field | Type | Description |
| ----- | ---- | ----------- |
| units |  [int64](#int64) | Целая часть суммы, может быть отрицательным числом |
| nano |  [int32](#int32) | Дробная часть суммы, может быть отрицательным числом |