ibapi 3.0.1

A Rust implementation of the Interactive Brokers TWS API, providing a reliable and user friendly interface for TWS and IB Gateway. Designed with a focus on simplicity and performance.
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
//! Builders for news-domain request and response messages.
//!
//! `contract_news` and `broad_tape_news` reuse
//! [`market_data::MarketDataRequestBuilder`](super::market_data::MarketDataRequestBuilder),
//! since they ultimately fan out through `encode_request_market_data`.

use super::{RequestEncoder, ResponseProtoEncoder};
use crate::common::test_utils::helpers::constants::{TEST_CONTRACT_ID, TEST_REQ_ID_FIRST};
use crate::messages::OutgoingMessages;
use crate::proto;
use crate::proto::encoders::{some_bool, some_str};
use crate::ToField;
use time::OffsetDateTime;

empty_request_builder!(NewsProvidersRequestBuilder, NewsProvidersRequest, OutgoingMessages::RequestNewsProviders);

empty_request_builder!(
    CancelNewsBulletinsRequestBuilder,
    CancelNewsBulletins,
    OutgoingMessages::CancelNewsBulletin
);

#[derive(Clone, Copy, Debug, Default)]
pub struct NewsBulletinsRequestBuilder {
    pub all_messages: bool,
}

impl NewsBulletinsRequestBuilder {
    pub fn all_messages(mut self, v: bool) -> Self {
        self.all_messages = v;
        self
    }
}

impl RequestEncoder for NewsBulletinsRequestBuilder {
    type Proto = proto::NewsBulletinsRequest;
    const MSG_ID: OutgoingMessages = OutgoingMessages::RequestNewsBulletins;

    fn to_proto(&self) -> Self::Proto {
        proto::NewsBulletinsRequest {
            all_messages: some_bool(self.all_messages),
        }
    }
}

#[derive(Clone, Debug)]
pub struct HistoricalNewsRequestBuilder {
    pub request_id: i32,
    pub contract_id: i32,
    pub provider_codes: Vec<String>,
    pub start_time: OffsetDateTime,
    pub end_time: OffsetDateTime,
    pub total_results: u8,
}

impl Default for HistoricalNewsRequestBuilder {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
            contract_id: TEST_CONTRACT_ID,
            provider_codes: Vec::new(),
            start_time: OffsetDateTime::UNIX_EPOCH,
            end_time: OffsetDateTime::UNIX_EPOCH,
            total_results: 0,
        }
    }
}

impl HistoricalNewsRequestBuilder {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
    pub fn contract_id(mut self, v: i32) -> Self {
        self.contract_id = v;
        self
    }
    pub fn provider_codes<S: AsRef<str>>(mut self, v: &[S]) -> Self {
        self.provider_codes = v.iter().map(|s| s.as_ref().to_string()).collect();
        self
    }
    pub fn start_time(mut self, v: OffsetDateTime) -> Self {
        self.start_time = v;
        self
    }
    pub fn end_time(mut self, v: OffsetDateTime) -> Self {
        self.end_time = v;
        self
    }
    pub fn total_results(mut self, v: u8) -> Self {
        self.total_results = v;
        self
    }
}

impl RequestEncoder for HistoricalNewsRequestBuilder {
    type Proto = proto::HistoricalNewsRequest;
    const MSG_ID: OutgoingMessages = OutgoingMessages::RequestHistoricalNews;

    fn to_proto(&self) -> Self::Proto {
        proto::HistoricalNewsRequest {
            req_id: Some(self.request_id),
            con_id: Some(self.contract_id),
            provider_codes: Some(self.provider_codes.join("+")),
            start_date_time: Some(self.start_time.to_field()),
            end_date_time: Some(self.end_time.to_field()),
            total_results: Some(self.total_results as i32),
            historical_news_options: Default::default(),
        }
    }
}

#[derive(Clone, Debug)]
pub struct NewsArticleRequestBuilder {
    pub request_id: i32,
    pub provider_code: String,
    pub article_id: String,
}

impl Default for NewsArticleRequestBuilder {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
            provider_code: String::new(),
            article_id: String::new(),
        }
    }
}

impl NewsArticleRequestBuilder {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
    pub fn provider_code(mut self, v: impl Into<String>) -> Self {
        self.provider_code = v.into();
        self
    }
    pub fn article_id(mut self, v: impl Into<String>) -> Self {
        self.article_id = v.into();
        self
    }
}

impl RequestEncoder for NewsArticleRequestBuilder {
    type Proto = proto::NewsArticleRequest;
    const MSG_ID: OutgoingMessages = OutgoingMessages::RequestNewsArticle;

    fn to_proto(&self) -> Self::Proto {
        proto::NewsArticleRequest {
            req_id: Some(self.request_id),
            provider_code: Some(self.provider_code.clone()),
            article_id: Some(self.article_id.clone()),
            news_article_options: Default::default(),
        }
    }
}

// =============================================================================
// Response builders
// =============================================================================

/// One row of a `NewsProviders` (msg 85) response.
#[derive(Clone, Debug)]
pub struct NewsProviderEntry {
    pub code: String,
    pub name: String,
}

/// Builder for `NewsProviders` (msg 85) responses.
#[derive(Clone, Debug, Default)]
pub struct NewsProvidersResponse {
    pub providers: Vec<NewsProviderEntry>,
}

impl NewsProvidersResponse {
    pub fn provider(mut self, code: impl Into<String>, name: impl Into<String>) -> Self {
        self.providers.push(NewsProviderEntry {
            code: code.into(),
            name: name.into(),
        });
        self
    }
}

impl ResponseProtoEncoder for NewsProvidersResponse {
    type Proto = proto::NewsProviders;

    fn to_proto(&self) -> Self::Proto {
        proto::NewsProviders {
            news_providers: self
                .providers
                .iter()
                .map(|p| proto::NewsProvider {
                    provider_code: some_str(&p.code),
                    provider_name: some_str(&p.name),
                })
                .collect(),
        }
    }
}

/// Builder for `NewsBulletins` (msg 14) responses.
#[derive(Clone, Debug, Default)]
pub struct NewsBulletinResponse {
    pub message_id: i32,
    pub message_type: i32,
    pub message: String,
    pub exchange: String,
}

impl NewsBulletinResponse {
    pub fn message_id(mut self, v: i32) -> Self {
        self.message_id = v;
        self
    }
    pub fn message_type(mut self, v: i32) -> Self {
        self.message_type = v;
        self
    }
    pub fn message(mut self, v: impl Into<String>) -> Self {
        self.message = v.into();
        self
    }
    pub fn exchange(mut self, v: impl Into<String>) -> Self {
        self.exchange = v.into();
        self
    }
}

impl ResponseProtoEncoder for NewsBulletinResponse {
    type Proto = proto::NewsBulletin;

    fn to_proto(&self) -> Self::Proto {
        proto::NewsBulletin {
            news_msg_id: Some(self.message_id),
            news_msg_type: Some(self.message_type),
            news_message: some_str(&self.message),
            originating_exch: some_str(&self.exchange),
        }
    }
}

/// Builder for `HistoricalNews` (msg 86) responses.
#[derive(Clone, Debug)]
pub struct HistoricalNewsResponse {
    pub request_id: i32,
    pub time: String,
    pub provider_code: String,
    pub article_id: String,
    pub headline: String,
}

impl Default for HistoricalNewsResponse {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
            time: String::new(),
            provider_code: String::new(),
            article_id: String::new(),
            headline: String::new(),
        }
    }
}

impl HistoricalNewsResponse {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
    pub fn time(mut self, v: impl Into<String>) -> Self {
        self.time = v.into();
        self
    }
    pub fn provider_code(mut self, v: impl Into<String>) -> Self {
        self.provider_code = v.into();
        self
    }
    pub fn article_id(mut self, v: impl Into<String>) -> Self {
        self.article_id = v.into();
        self
    }
    pub fn headline(mut self, v: impl Into<String>) -> Self {
        self.headline = v.into();
        self
    }
}

impl ResponseProtoEncoder for HistoricalNewsResponse {
    type Proto = proto::HistoricalNews;

    fn to_proto(&self) -> Self::Proto {
        proto::HistoricalNews {
            req_id: Some(self.request_id),
            time: some_str(&self.time),
            provider_code: some_str(&self.provider_code),
            article_id: some_str(&self.article_id),
            headline: some_str(&self.headline),
        }
    }
}

/// Builder for `HistoricalNewsEnd` (msg 87) responses.
#[derive(Clone, Copy, Debug)]
pub struct HistoricalNewsEndResponse {
    pub request_id: i32,
}

impl Default for HistoricalNewsEndResponse {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
        }
    }
}

impl HistoricalNewsEndResponse {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
}

impl ResponseProtoEncoder for HistoricalNewsEndResponse {
    type Proto = proto::HistoricalNewsEnd;

    fn to_proto(&self) -> Self::Proto {
        proto::HistoricalNewsEnd {
            req_id: Some(self.request_id),
            has_more: None,
        }
    }
}

/// Builder for `NewsArticle` (msg 83) responses.
#[derive(Clone, Debug)]
pub struct NewsArticleResponse {
    pub request_id: i32,
    pub article_type: i32,
    pub article_text: String,
}

impl Default for NewsArticleResponse {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
            article_type: 0,
            article_text: String::new(),
        }
    }
}

impl NewsArticleResponse {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
    pub fn article_type(mut self, v: i32) -> Self {
        self.article_type = v;
        self
    }
    pub fn article_text(mut self, v: impl Into<String>) -> Self {
        self.article_text = v.into();
        self
    }
}

impl ResponseProtoEncoder for NewsArticleResponse {
    type Proto = proto::NewsArticle;

    fn to_proto(&self) -> Self::Proto {
        proto::NewsArticle {
            req_id: Some(self.request_id),
            article_type: Some(self.article_type),
            article_text: some_str(&self.article_text),
        }
    }
}

/// Builder for `TickNews` (msg 84) responses.
#[derive(Clone, Debug)]
pub struct TickNewsResponse {
    pub request_id: i32,
    pub timestamp_millis: i64,
    pub provider_code: String,
    pub article_id: String,
    pub headline: String,
    pub extra_data: String,
}

impl Default for TickNewsResponse {
    fn default() -> Self {
        Self {
            request_id: TEST_REQ_ID_FIRST,
            timestamp_millis: 0,
            provider_code: String::new(),
            article_id: String::new(),
            headline: String::new(),
            extra_data: String::new(),
        }
    }
}

impl TickNewsResponse {
    pub fn request_id(mut self, v: i32) -> Self {
        self.request_id = v;
        self
    }
    pub fn timestamp_millis(mut self, v: i64) -> Self {
        self.timestamp_millis = v;
        self
    }
    pub fn provider_code(mut self, v: impl Into<String>) -> Self {
        self.provider_code = v.into();
        self
    }
    pub fn article_id(mut self, v: impl Into<String>) -> Self {
        self.article_id = v.into();
        self
    }
    pub fn headline(mut self, v: impl Into<String>) -> Self {
        self.headline = v.into();
        self
    }
    pub fn extra_data(mut self, v: impl Into<String>) -> Self {
        self.extra_data = v.into();
        self
    }
}

impl ResponseProtoEncoder for TickNewsResponse {
    type Proto = proto::TickNews;

    fn to_proto(&self) -> Self::Proto {
        proto::TickNews {
            req_id: Some(self.request_id),
            timestamp: Some(self.timestamp_millis),
            provider_code: some_str(&self.provider_code),
            article_id: some_str(&self.article_id),
            headline: some_str(&self.headline),
            extra_data: some_str(&self.extra_data),
        }
    }
}

// =============================================================================
// Entry-point functions
// =============================================================================

pub fn news_providers_request() -> NewsProvidersRequestBuilder {
    NewsProvidersRequestBuilder
}

pub fn news_bulletins_request() -> NewsBulletinsRequestBuilder {
    NewsBulletinsRequestBuilder::default()
}

pub fn cancel_news_bulletins_request() -> CancelNewsBulletinsRequestBuilder {
    CancelNewsBulletinsRequestBuilder
}

pub fn historical_news_request() -> HistoricalNewsRequestBuilder {
    HistoricalNewsRequestBuilder::default()
}

pub fn news_article_request() -> NewsArticleRequestBuilder {
    NewsArticleRequestBuilder::default()
}

pub fn news_providers() -> NewsProvidersResponse {
    NewsProvidersResponse::default()
}

pub fn news_bulletin() -> NewsBulletinResponse {
    NewsBulletinResponse::default()
}

pub fn historical_news() -> HistoricalNewsResponse {
    HistoricalNewsResponse::default()
}

pub fn historical_news_end() -> HistoricalNewsEndResponse {
    HistoricalNewsEndResponse::default()
}

pub fn news_article() -> NewsArticleResponse {
    NewsArticleResponse::default()
}

pub fn tick_news() -> TickNewsResponse {
    TickNewsResponse::default()
}