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
//! Asynchronous implementation of news functionality
use super::common::{self, decoders, encoders};
use super::*;
use crate::client::{ClientRequestBuilders, SubscriptionBuilderExt};
use crate::common::request_helpers::{self, expect_proto};
use crate::contracts::Contract;
use crate::messages::OutgoingMessages;
use crate::subscriptions::Subscription;
use crate::{Client, Error};
impl Client {
/// Requests news providers which the user has subscribed to.
///
/// # Errors
/// [`Error::Timeout`] if TWS sends no answer within 30 seconds, or within [`one_shot_timeout`](crate::ClientBuilder::one_shot_timeout) when set.
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
/// let providers = client.news_providers().await.expect("news_providers failed");
/// for provider in providers {
/// println!("{provider:?}");
/// }
/// }
/// ```
pub async fn news_providers(&self) -> Result<Vec<NewsProvider>, Error> {
request_helpers::one_shot_shared(
self,
OutgoingMessages::RequestNewsProviders,
encoders::encode_request_news_providers,
expect_proto(decoders::decode_news_providers_proto),
)
.await
}
/// Subscribes to IB's News Bulletins.
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
/// let subscription = client.news_bulletins(true).await.expect("news_bulletins failed");
/// let mut bulletins = subscription.filter_data();
/// while let Some(bulletin) = bulletins.next().await {
/// println!("{bulletin:?}");
/// }
/// }
/// ```
pub async fn news_bulletins(&self, all_messages: bool) -> Result<Subscription<NewsBulletin>, Error> {
let request = encoders::encode_request_news_bulletins(all_messages)?;
self.subscription().send_shared(OutgoingMessages::RequestNewsBulletins, request).await
}
/// Historical News Headlines
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
/// use time::macros::datetime;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
///
/// let subscription = client
/// .historical_news(
/// 8314, // IBM
/// &["BRFG"],
/// datetime!(2025-01-01 0:00 UTC),
/// datetime!(2025-01-31 23:59 UTC),
/// 10,
/// )
/// .await
/// .expect("historical_news failed");
///
/// let mut articles = subscription.filter_data();
/// while let Some(article) = articles.next().await {
/// println!("{article:?}");
/// }
/// }
/// ```
// Flat by design (#901): all five arguments are required with no meaningful default, so a
// builder would buy nothing over positional args (docs/rules/style/param-budget.md).
pub async fn historical_news(
&self,
contract_id: i32,
provider_codes: &[&str],
start_time: OffsetDateTime,
end_time: OffsetDateTime,
total_results: u8,
) -> Result<Subscription<NewsArticle>, Error> {
let builder = self.request();
let request =
encoders::encode_request_historical_news(builder.request_id(), contract_id, provider_codes, start_time, end_time, total_results)?;
builder.send(request).await
}
/// Requests news article body
///
/// # Errors
///
/// [`Error::Parse`] if TWS reports an article type other than text (`0`) or binary (`1`).
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
/// let article = client
/// .news_article("BRFG", "BRFG$0a3e3f54")
/// .await
/// .expect("news_article failed");
/// println!("{article:?}");
/// }
/// ```
pub async fn news_article(&self, provider_code: &str, article_id: &str) -> Result<NewsArticleBody, Error> {
request_helpers::one_shot_by_request_id(
self,
|request_id| encoders::encode_request_news_article(request_id, provider_code, article_id),
expect_proto(decoders::decode_news_article_proto),
)
.await
}
/// Subscribe to news for a specific contract
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
/// let contract = Contract::stock("AAPL").build();
/// let subscription = client.contract_news(&contract, &["BRFG"]).await.expect("contract_news failed");
/// let mut articles = subscription.filter_data();
/// while let Some(article) = articles.next().await {
/// println!("{article:?}");
/// }
/// }
/// ```
pub async fn contract_news(&self, contract: &Contract, provider_codes: &[&str]) -> Result<Subscription<NewsArticle>, Error> {
let builder = self.request();
let request = encoders::encode_contract_news_request(builder.request_id(), contract, provider_codes)?;
builder
.send_with_context(request, common::tick_news_context(self.decoder_context()))
.await
}
/// Subscribe to broad tape news
///
/// # Examples
///
/// ```no_run
/// use ibapi::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let client = Client::connect("127.0.0.1:4002", 100).await.expect("connection failed");
/// let subscription = client.broad_tape_news("BRFG").await.expect("broad_tape_news failed");
/// let mut articles = subscription.filter_data();
/// while let Some(article) = articles.next().await {
/// println!("{article:?}");
/// }
/// }
/// ```
pub async fn broad_tape_news(&self, provider_code: &str) -> Result<Subscription<NewsArticle>, Error> {
let builder = self.request();
let request = encoders::encode_broad_tape_news_request(builder.request_id(), provider_code)?;
builder
.send_with_context(request, common::tick_news_context(self.decoder_context()))
.await
}
}
#[cfg(test)]
#[path = "async_tests.rs"]
mod tests;