finam 0.8.0

SDK для работы с API Финам
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
// This file is @generated by prost-build.
/// Запрос получения информации по конкретному аккаунту
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetAccountRequest {
    /// Идентификатор аккаунта
    #[prost(string, tag = "1")]
    pub account_id: ::prost::alloc::string::String,
}
/// Информация о конкретном аккаунте
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetAccountResponse {
    /// Идентификатор аккаунта
    #[prost(string, tag = "1")]
    pub account_id: ::prost::alloc::string::String,
    /// Тип аккаунта
    #[prost(string, tag = "2")]
    pub r#type: ::prost::alloc::string::String,
    /// Статус аккаунта
    #[prost(string, tag = "3")]
    pub status: ::prost::alloc::string::String,
    /// Доступные средства плюс стоимость открытых позиций
    #[prost(message, optional, tag = "4")]
    pub equity: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Нереализованная прибыль
    #[prost(message, optional, tag = "5")]
    pub unrealized_profit: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Позиции. Открытые, плюс теоретические (по неисполненным активным заявкам)
    #[prost(message, repeated, tag = "6")]
    pub positions: ::prost::alloc::vec::Vec<Position>,
    /// Сумма собственных денежных средств на счете, доступная для торговли. Не включает маржинальные средства.
    #[prost(message, repeated, tag = "7")]
    pub cash: ::prost::alloc::vec::Vec<
        super::super::super::super::google::r#type::Money,
    >,
    /// Дата открытия счета
    #[prost(message, optional, tag = "11")]
    pub open_account_date: ::core::option::Option<::prost_types::Timestamp>,
    /// Дата первой торговой транзакции
    #[prost(message, optional, tag = "12")]
    pub first_trade_date: ::core::option::Option<::prost_types::Timestamp>,
    /// Дата первой неторговой транзакции
    #[prost(message, optional, tag = "13")]
    pub first_non_trade_date: ::core::option::Option<::prost_types::Timestamp>,
    #[prost(oneof = "get_account_response::Portfolio", tags = "8, 9, 10")]
    pub portfolio: ::core::option::Option<get_account_response::Portfolio>,
}
/// Nested message and enum types in `GetAccountResponse`.
pub mod get_account_response {
    #[derive(Clone, PartialEq, Eq, Hash, ::prost::Oneof)]
    pub enum Portfolio {
        /// Общий тип для счетов Московской Биржи. Включает в себя как единые, так и моно счета.
        #[prost(message, tag = "8")]
        PortfolioMc(super::Mc),
        /// Тип портфеля для счетов на американских рынках.
        #[prost(message, tag = "9")]
        PortfolioMct(super::Mct),
        /// Тип портфеля для торговли на срочном рынке Московской Биржи.
        #[prost(message, tag = "10")]
        PortfolioForts(super::Forts),
    }
}
/// Общий тип для счетов Московской Биржи. Включает в себя как единые, так и специализированные (моно) счета для разных секций биржи.
/// Единый торговый счет (ЕТС): Позволяет торговать на нескольких рынках (фондовый, валютный. срочный, spb, иностранные бумаги, иностранные фьючерсы) с единой денежной позиции.
/// Моно-счет фондового рынка MOEX: Изолированный счет для торговли акциями, облигациями и паями.
/// Моно-счет валютного рынка MOEX: Изолированный счет для операций с валютными парами (например, CNYRUB_TOM).
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Mc {
    /// Сумма собственных денежных средств на счете, доступная для торговли. Включает маржинальные средства.
    #[prost(message, optional, tag = "1")]
    pub available_cash: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Начальная маржа
    #[prost(message, optional, tag = "2")]
    pub initial_margin: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Минимальная маржа
    #[prost(message, optional, tag = "3")]
    pub maintenance_margin: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
}
/// Тип портфеля для счетов на американских рынках.
/// Предоставляет доступ к биржам США: NYSE, NASDAQ, CBOE, CME, сделки с американскими акциями, фьючерсами и опционами.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Mct {}
/// Тип портфеля для торговли на срочном рынке Московской Биржи.
/// Предназначен для работы с производными финансовыми инструментами: фьючерсами и опционами.
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Forts {
    /// Сумма собственных денежных средств на счете, доступная для торговли. Включает маржинальные средства.
    #[prost(message, optional, tag = "1")]
    pub available_cash: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Минимальная маржа (необходимая сумма обеспечения под открытые позици)
    #[prost(message, optional, tag = "2")]
    pub money_reserved: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
}
/// Запрос получения истории по сделкам
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct TradesRequest {
    /// Идентификатор аккаунта
    #[prost(string, tag = "1")]
    pub account_id: ::prost::alloc::string::String,
    /// Лимит количества сделок
    #[prost(int32, tag = "2")]
    pub limit: i32,
    /// Начало и окончание запрашиваемого периода, Unix epoch time
    #[prost(message, optional, tag = "3")]
    pub interval: ::core::option::Option<
        super::super::super::super::google::r#type::Interval,
    >,
}
/// История по сделкам
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TradesResponse {
    /// Сделки по аккаунту
    #[prost(message, repeated, tag = "1")]
    pub trades: ::prost::alloc::vec::Vec<super::AccountTrade>,
}
/// Запрос получения списка транзакций
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct TransactionsRequest {
    /// Идентификатор аккаунта
    #[prost(string, tag = "1")]
    pub account_id: ::prost::alloc::string::String,
    /// Лимит количества транзакций
    #[prost(int32, tag = "2")]
    pub limit: i32,
    /// Начало и окончание запрашиваемого периода, Unix epoch time
    #[prost(message, optional, tag = "3")]
    pub interval: ::core::option::Option<
        super::super::super::super::google::r#type::Interval,
    >,
}
/// Список транзакций
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TransactionsResponse {
    /// Транзакции по аккаунту
    #[prost(message, repeated, tag = "1")]
    pub transactions: ::prost::alloc::vec::Vec<Transaction>,
}
/// Информация о позиции
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Position {
    /// Символ инструмента
    #[prost(string, tag = "1")]
    pub symbol: ::prost::alloc::string::String,
    /// Количество в шт., значение со знаком определяющее (long-short)
    #[prost(message, optional, tag = "2")]
    pub quantity: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Средняя цена. Не заполняется для FORTS позиций
    #[prost(message, optional, tag = "3")]
    pub average_price: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Текущая цена
    #[prost(message, optional, tag = "4")]
    pub current_price: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Поддерживающее гарантийное обеспечение. Заполняется только для FORTS позиций
    #[prost(message, optional, tag = "5")]
    pub maintenance_margin: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Прибыль или убыток за текущий день (PnL). Не заполняется для FORTS позиций
    #[prost(message, optional, tag = "6")]
    pub daily_pnl: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
    /// Суммарная нереализованная прибыль или убыток (PnL) текущей позиции
    #[prost(message, optional, tag = "7")]
    pub unrealized_pnl: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
}
/// Информация о транзакции
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Transaction {
    /// Идентификатор транзакции
    #[prost(string, tag = "1")]
    pub id: ::prost::alloc::string::String,
    /// Тип транзакции из TransactionCategory
    #[deprecated]
    #[prost(string, tag = "2")]
    pub category: ::prost::alloc::string::String,
    /// Метка времени
    #[prost(message, optional, tag = "4")]
    pub timestamp: ::core::option::Option<::prost_types::Timestamp>,
    /// Символ инструмента
    #[prost(string, tag = "5")]
    pub symbol: ::prost::alloc::string::String,
    /// Изменение в деньгах
    #[prost(message, optional, tag = "6")]
    pub change: ::core::option::Option<
        super::super::super::super::google::r#type::Money,
    >,
    /// Информация о сделке
    #[prost(message, optional, tag = "7")]
    pub trade: ::core::option::Option<transaction::Trade>,
    /// Категория транзакции из TransactionCategory.
    #[prost(enumeration = "transaction::TransactionCategory", tag = "8")]
    pub transaction_category: i32,
    /// Наименование транзакции
    #[prost(string, tag = "9")]
    pub transaction_name: ::prost::alloc::string::String,
    /// Изменение в штуках, только для трансфера бумаг (для TransactionCategory = TRANSFER)
    #[prost(message, optional, tag = "10")]
    pub change_qty: ::core::option::Option<
        super::super::super::super::google::r#type::Decimal,
    >,
}
/// Nested message and enum types in `Transaction`.
pub mod transaction {
    /// Объект заполняется для торговых типов транзакций
    #[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
    pub struct Trade {
        /// Количество в шт.
        #[prost(message, optional, tag = "1")]
        pub size: ::core::option::Option<
            super::super::super::super::super::google::r#type::Decimal,
        >,
        /// Цена сделки за штуку. Цена исполнения/Размер премии по опциону. Это цена заключения, значение берется из сделки.
        #[prost(message, optional, tag = "2")]
        pub price: ::core::option::Option<
            super::super::super::super::super::google::r#type::Decimal,
        >,
        /// НКД. Заполнено если в сделке есть НКД
        #[prost(message, optional, tag = "3")]
        pub accrued_interest: ::core::option::Option<
            super::super::super::super::super::google::r#type::Decimal,
        >,
    }
    /// Категории транзакции.
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum TransactionCategory {
        /// Прочее
        Others = 0,
        /// Ввод ДС
        Deposit = 1,
        /// Вывод ДС
        Withdraw = 2,
        /// Доход
        Income = 5,
        /// Комиссия
        Commission = 7,
        /// Налог
        Tax = 8,
        /// Наследство
        Inheritance = 9,
        /// Перевод ДС
        Transfer = 11,
        /// Расторжение договора
        ContractTermination = 12,
        /// Расходы
        Outcomes = 13,
        /// Штраф
        Fine = 15,
        /// Займ
        Loan = 19,
    }
    impl TransactionCategory {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                Self::Others => "OTHERS",
                Self::Deposit => "DEPOSIT",
                Self::Withdraw => "WITHDRAW",
                Self::Income => "INCOME",
                Self::Commission => "COMMISSION",
                Self::Tax => "TAX",
                Self::Inheritance => "INHERITANCE",
                Self::Transfer => "TRANSFER",
                Self::ContractTermination => "CONTRACT_TERMINATION",
                Self::Outcomes => "OUTCOMES",
                Self::Fine => "FINE",
                Self::Loan => "LOAN",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "OTHERS" => Some(Self::Others),
                "DEPOSIT" => Some(Self::Deposit),
                "WITHDRAW" => Some(Self::Withdraw),
                "INCOME" => Some(Self::Income),
                "COMMISSION" => Some(Self::Commission),
                "TAX" => Some(Self::Tax),
                "INHERITANCE" => Some(Self::Inheritance),
                "TRANSFER" => Some(Self::Transfer),
                "CONTRACT_TERMINATION" => Some(Self::ContractTermination),
                "OUTCOMES" => Some(Self::Outcomes),
                "FINE" => Some(Self::Fine),
                "LOAN" => Some(Self::Loan),
                _ => None,
            }
        }
    }
}
/// Generated client implementations.
pub mod accounts_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Сервис аккаунтов
    #[derive(Debug, Clone)]
    pub struct AccountsServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl AccountsServiceClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> AccountsServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::Body>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> AccountsServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::Body>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::Body>,
            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
        {
            AccountsServiceClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Получение информации по конкретному аккаунту
        /// Пример HTTP запроса:
        /// GET /v1/accounts/A12345
        /// Authorization: <token>
        pub async fn get_account(
            &mut self,
            request: impl tonic::IntoRequest<super::GetAccountRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetAccountResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic_prost::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/grpc.tradeapi.v1.accounts.AccountsService/GetAccount",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "grpc.tradeapi.v1.accounts.AccountsService",
                        "GetAccount",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Получение истории по сделкам аккаунта
        /// Пример HTTP запроса:
        /// GET /v1/accounts/A12345/trades?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z
        /// Authorization: <token>
        ///
        /// Параметры:
        ///
        /// * account_id - передается в URL пути
        /// * limit и interval - передаются как query-параметры
        pub async fn trades(
            &mut self,
            request: impl tonic::IntoRequest<super::TradesRequest>,
        ) -> std::result::Result<tonic::Response<super::TradesResponse>, tonic::Status> {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic_prost::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/grpc.tradeapi.v1.accounts.AccountsService/Trades",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "grpc.tradeapi.v1.accounts.AccountsService",
                        "Trades",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Получение списка транзакций аккаунта
        /// Пример HTTP запроса:
        /// GET /v1/accounts/A12345/transactions?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z
        /// Authorization: <token>
        ///
        /// Параметры:
        ///
        /// * account_id - передается в URL пути
        /// * limit и interval - передаются как query-параметры
        pub async fn transactions(
            &mut self,
            request: impl tonic::IntoRequest<super::TransactionsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::TransactionsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic_prost::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/grpc.tradeapi.v1.accounts.AccountsService/Transactions",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "grpc.tradeapi.v1.accounts.AccountsService",
                        "Transactions",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}