ibapi 3.3.0

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

//! TWS/Gateway configuration read and write.
//!
//! [`Client::config`](crate::Client::config) reads the API, precautions,
//! orders, and lock-and-exit settings the running gateway is configured with.
//! [`Client::update_config`](crate::Client::update_config) pushes partial edits
//! back through a fluent [`UpdateConfigBuilder`](crate::config::UpdateConfigBuilder),
//! returning an [`UpdateConfigResponse`](crate::config::UpdateConfigResponse) that
//! reports the changed fields, errors, and any warnings the gateway raised.
//!
//! Read fields mirror the wire message and are optional — a `None` means the
//! gateway did not report that setting, not that it is disabled. The same
//! domain types are reused as the write-side input: construct a partial edit
//! with `..Default::default()` and set only the fields you want to change.

use serde::{Deserialize, Serialize};

mod builder;
mod common;

// Re-export common functionality
use common::encoders;

pub use builder::UpdateConfigBuilder;

// Feature-specific implementations
#[cfg(feature = "sync")]
mod sync;

#[cfg(feature = "async")]
mod r#async;

/// A snapshot of the TWS/Gateway configuration.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Config {
    /// Lock-and-exit (auto-logoff) settings.
    pub lock_and_exit: Option<LockAndExit>,
    /// Configurable API message prompts and their default actions.
    pub messages: Vec<MessageSetting>,
    /// API-level configuration (precautions and settings).
    pub api: Option<ApiConfig>,
    /// Order-handling configuration.
    pub orders: Option<OrdersConfig>,
}

/// Auto-logoff / lock-and-exit configuration.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct LockAndExit {
    /// Time of day at which the gateway auto-logs off.
    pub auto_logoff_time: Option<String>,
    /// Auto-logoff period.
    pub auto_logoff_period: Option<String>,
    /// Auto-logoff type.
    pub auto_logoff_type: Option<String>,
}

/// A single configurable API message prompt.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct MessageSetting {
    /// Message identifier.
    pub id: Option<i32>,
    /// Message title.
    pub title: Option<String>,
    /// Message body.
    pub message: Option<String>,
    /// The default action taken for this prompt.
    pub default_action: Option<String>,
    /// Whether this prompt is enabled.
    pub enabled: Option<bool>,
}

/// API-level configuration.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ApiConfig {
    /// Order-precaution bypass flags.
    pub precautions: Option<ApiPrecautions>,
    /// General API settings.
    pub settings: Option<ApiSettings>,
}

/// Order-precaution bypass flags. Each `Some(true)` means the corresponding
/// safety confirmation is bypassed.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub struct ApiPrecautions {
    /// Bypass order precautions.
    pub bypass_order_precautions: Option<bool>,
    /// Bypass bond warning.
    pub bypass_bond_warning: Option<bool>,
    /// Bypass negative-yield confirmation.
    pub bypass_negative_yield_confirmation: Option<bool>,
    /// Bypass called-bond warning.
    pub bypass_called_bond_warning: Option<bool>,
    /// Bypass same-action pair-trade warning.
    pub bypass_same_action_pair_trade_warning: Option<bool>,
    /// Bypass flagged-accounts warning.
    pub bypass_flagged_accounts_warning: Option<bool>,
    /// Bypass price-based volatility warning.
    pub bypass_price_based_volatility_warning: Option<bool>,
    /// Bypass redirect-order warning.
    pub bypass_redirect_order_warning: Option<bool>,
    /// Bypass no-overfill-protection warning.
    pub bypass_no_overfill_protection: Option<bool>,
    /// Bypass route-marketable-to-BBO warning.
    pub bypass_route_marketable_to_bbo: Option<bool>,
}

/// General API settings reported by the gateway.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ApiSettings {
    /// Read-only API mode.
    pub read_only_api: Option<bool>,
    /// Report total quantity for mutual funds.
    pub total_quantity_for_mutual_funds: Option<bool>,
    /// Download open orders on connection.
    pub download_open_orders_on_connection: Option<bool>,
    /// Include virtual FX positions.
    pub include_virtual_fx_positions: Option<bool>,
    /// Prepare daily PnL.
    pub prepare_daily_pnl: Option<bool>,
    /// Send status updates for volatility orders.
    pub send_status_updates_for_volatility_orders: Option<bool>,
    /// API message encoding.
    pub encode_api_messages: Option<String>,
    /// Socket port the gateway listens on.
    pub socket_port: Option<i32>,
    /// Use negative auto-range.
    pub use_negative_auto_range: Option<bool>,
    /// Create an API message log file.
    pub create_api_message_log_file: Option<bool>,
    /// Include market data in the log file.
    pub include_market_data_in_log_file: Option<bool>,
    /// Expose the trading schedule to the API.
    pub expose_trading_schedule_to_api: Option<bool>,
    /// Split insured deposit from cash balance.
    pub split_insured_deposit_from_cash_balance: Option<bool>,
    /// Send zero positions for today only.
    pub send_zero_positions_for_today_only: Option<bool>,
    /// Let API account requests switch subscription.
    pub let_api_account_requests_switch_subscription: Option<bool>,
    /// Use account groups with allocation methods.
    pub use_account_groups_with_allocation_methods: Option<bool>,
    /// Logging level.
    pub logging_level: Option<String>,
    /// Master client id.
    pub master_client_id: Option<i32>,
    /// Bulk data timeout.
    pub bulk_data_timeout: Option<i32>,
    /// Component-exchange separator.
    pub component_exch_separator: Option<String>,
    /// Show forex data in 1/10 pips.
    pub show_forex_data_in_1_10_pips: Option<bool>,
    /// Allow forex trading in 1/10 pips.
    pub allow_forex_trading_in_1_10_pips: Option<bool>,
    /// Round account values to the nearest whole number.
    pub round_account_values_to_nearest_whole_number: Option<bool>,
    /// Send market data in lots for US stocks.
    pub send_market_data_in_lots_for_us_stocks: Option<bool>,
    /// Show advanced order reject in UI.
    pub show_advanced_order_reject_in_ui: Option<bool>,
    /// Reject messages above max rate.
    pub reject_messages_above_max_rate: Option<bool>,
    /// Maintain connection on incorrect fields.
    pub maintain_connection_on_incorrect_fields: Option<bool>,
    /// Compatibility mode for NASDAQ stocks.
    pub compatibility_mode_nasdaq_stocks: Option<bool>,
    /// Send instrument timezone.
    pub send_instrument_timezone: Option<String>,
    /// Send forex data in compatibility mode.
    pub send_forex_data_in_compatibility_mode: Option<bool>,
    /// Maintain and resubmit orders on reconnect.
    pub maintain_and_resubmit_orders_on_reconnect: Option<bool>,
    /// Historical data max size.
    pub historical_data_max_size: Option<i32>,
    /// Auto-report netting-event contract trades.
    pub auto_report_netting_event_contract_trades: Option<bool>,
    /// Option-exercise request type.
    pub option_exercise_request_type: Option<String>,
    /// Allow localhost connections only.
    pub allow_localhost_only: Option<bool>,
    /// Trusted IP addresses.
    pub trusted_ips: Vec<String>,
}

/// Order-handling configuration.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct OrdersConfig {
    /// Smart-routing configuration.
    pub smart_routing: Option<OrdersSmartRouting>,
}

/// Smart-routing configuration.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct OrdersSmartRouting {
    /// Seek price improvement.
    pub seek_price_improvement: Option<bool>,
    /// Pre-open reroute.
    pub pre_open_reroute: Option<bool>,
    /// Do not route to dark pools.
    pub do_not_route_to_dark_pools: Option<bool>,
    /// Default algorithm.
    pub default_algorithm: Option<String>,
}

/// The gateway's response to an [`update_config`](crate::Client::update_config)
/// request.
///
/// If `warnings` is non-empty, the edit was not applied — re-submit the same
/// edit with each warning echoed via
/// [`UpdateConfigBuilder::accept_warning`] to proceed.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct UpdateConfigResponse {
    /// Outcome status reported by the gateway.
    pub status: Option<String>,
    /// Human-readable status message.
    pub message: Option<String>,
    /// Names of the settings that were changed.
    pub changed_fields: Vec<String>,
    /// Errors that prevented the edit from applying.
    pub errors: Vec<String>,
    /// Warnings the caller must acknowledge (echo back via
    /// [`UpdateConfigBuilder::accept_warning`]) before the edit is applied.
    pub warnings: Vec<ConfigWarning>,
}

/// A warning raised by the gateway while validating an
/// [`update_config`](crate::Client::update_config) edit.
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ConfigWarning {
    /// Identifier of the message prompt this warning corresponds to.
    pub message_id: Option<i32>,
    /// Warning title.
    pub title: Option<String>,
    /// Warning body.
    pub message: Option<String>,
}