ibapi 2.11.2

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
//! Message parser registry for decoding TWS protocol messages into structured fields
//!
//! This module provides a registry of parsers that can decode raw TWS messages
//! into human-readable field names and values, useful for debugging, logging,
//! and mock server development.

use super::{IncomingMessages, OutgoingMessages};
use std::collections::HashMap;

/// Represents a parsed field in a TWS message
#[derive(Debug, Clone)]
pub struct ParsedField {
    /// Human-readable field name.
    pub name: String,
    /// Field value formatted as a string.
    pub value: String,
}

/// Field definition for message parsing
type FieldTransform = Box<dyn Fn(&str) -> String + Send + Sync>;

/// Definition of a message field (index, name, optional transform).
pub struct FieldDef {
    index: usize,
    name: &'static str,
    transform: Option<FieldTransform>,
}

impl FieldDef {
    /// Create a new field definition using the provided index and name.
    pub fn new(index: usize, name: &'static str) -> Self {
        Self {
            index,
            name,
            transform: None,
        }
    }

    /// Attach a value transformation closure to this field definition.
    pub fn with_transform<F>(mut self, f: F) -> Self
    where
        F: Fn(&str) -> String + Send + Sync + 'static,
    {
        self.transform = Some(Box::new(f));
        self
    }
}

/// Message parser trait
pub trait MessageParser: Send + Sync {
    /// Parse a slice of raw fields into structured field/value pairs.
    fn parse(&self, parts: &[&str]) -> Vec<ParsedField>;
}

/// Generic field-based parser
pub struct FieldBasedParser {
    fields: Vec<FieldDef>,
}

impl FieldBasedParser {
    /// Create a parser that maps indices to field definitions.
    pub fn new(fields: Vec<FieldDef>) -> Self {
        Self { fields }
    }
}

impl MessageParser for FieldBasedParser {
    fn parse(&self, parts: &[&str]) -> Vec<ParsedField> {
        let mut result = Vec::new();

        for field_def in &self.fields {
            if let Some(value) = parts.get(field_def.index) {
                let processed_value = if let Some(transform) = &field_def.transform {
                    transform(value)
                } else {
                    value.to_string()
                };

                result.push(ParsedField {
                    name: field_def.name.to_string(),
                    value: processed_value,
                });
            }
        }

        result
    }
}

/// Parser with special handling for timestamp fields
pub struct TimestampParser {
    base_parser: FieldBasedParser,
    timestamp_index: usize,
}

impl TimestampParser {
    /// Create a timestamp-aware parser decorating a base parser.
    pub fn new(base_parser: FieldBasedParser, timestamp_index: usize) -> Self {
        Self {
            base_parser,
            timestamp_index,
        }
    }
}

impl MessageParser for TimestampParser {
    fn parse(&self, parts: &[&str]) -> Vec<ParsedField> {
        let mut fields = self.base_parser.parse(parts);

        // Add parsed timestamp if available
        if let Some(timestamp) = parts.get(self.timestamp_index) {
            if let Ok(ts) = timestamp.parse::<i64>() {
                if let Ok(dt) = time::OffsetDateTime::from_unix_timestamp(ts) {
                    fields.push(ParsedField {
                        name: "timestamp_parsed".to_string(),
                        value: dt.to_string(),
                    });
                }
            }
        }

        fields
    }
}

/// Registry of message parsers
pub struct MessageParserRegistry {
    request_parsers: HashMap<OutgoingMessages, Box<dyn MessageParser>>,
    response_parsers: HashMap<IncomingMessages, Box<dyn MessageParser>>,
}

impl MessageParserRegistry {
    /// Create a registry pre-populated with standard parsers.
    pub fn new() -> Self {
        let mut registry = Self {
            request_parsers: HashMap::new(),
            response_parsers: HashMap::new(),
        };

        registry.register_default_parsers();
        registry
    }

    fn register_default_parsers(&mut self) {
        // Register request parsers
        // RequestCurrentTime: message_type (49) + version (1)
        self.request_parsers.insert(
            OutgoingMessages::RequestCurrentTime,
            Box::new(FieldBasedParser::new(vec![FieldDef::new(0, "message_type"), FieldDef::new(1, "version")])),
        );

        // RequestManagedAccounts: message_type (17) + version (1)
        self.request_parsers.insert(
            OutgoingMessages::RequestManagedAccounts,
            Box::new(FieldBasedParser::new(vec![FieldDef::new(0, "message_type"), FieldDef::new(1, "version")])),
        );

        // RequestPositions: message_type (61) + version (1)
        self.request_parsers.insert(
            OutgoingMessages::RequestPositions,
            Box::new(FieldBasedParser::new(vec![FieldDef::new(0, "message_type"), FieldDef::new(1, "version")])),
        );

        // CancelPositions: message_type (64) + version (1)
        self.request_parsers.insert(
            OutgoingMessages::CancelPositions,
            Box::new(FieldBasedParser::new(vec![FieldDef::new(0, "message_type"), FieldDef::new(1, "version")])),
        );

        // RequestAccountSummary: message_type (62) + version (1) + request_id + group + tags
        self.request_parsers.insert(
            OutgoingMessages::RequestAccountSummary,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "request_id"),
                FieldDef::new(3, "group"),
                FieldDef::new(4, "tags"),
            ])),
        );

        // CancelAccountSummary: message_type (63) + version (1) + request_id
        self.request_parsers.insert(
            OutgoingMessages::CancelAccountSummary,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "request_id"),
            ])),
        );

        // RequestPnL: message_type (92) + request_id + account + model_code (empty)
        self.request_parsers.insert(
            OutgoingMessages::RequestPnL,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
                FieldDef::new(2, "account"),
                FieldDef::new(3, "model_code"),
            ])),
        );

        // CancelPnL: message_type (93) + request_id
        self.request_parsers.insert(
            OutgoingMessages::CancelPnL,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
            ])),
        );

        // RequestPnLSingle: message_type (94) + request_id + account + model_code + contract_id
        self.request_parsers.insert(
            OutgoingMessages::RequestPnLSingle,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
                FieldDef::new(2, "account"),
                FieldDef::new(3, "model_code"),
                FieldDef::new(4, "contract_id"),
            ])),
        );

        // CancelPnLSingle: message_type (95) + request_id
        self.request_parsers.insert(
            OutgoingMessages::CancelPnLSingle,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
            ])),
        );

        // Register response parsers
        // CurrentTime: message_type (49) + version (1) + timestamp
        self.response_parsers.insert(
            IncomingMessages::CurrentTime,
            Box::new(TimestampParser::new(
                FieldBasedParser::new(vec![
                    FieldDef::new(0, "message_type"),
                    FieldDef::new(1, "version"),
                    FieldDef::new(2, "timestamp"),
                ]),
                2, // timestamp_index
            )),
        );

        // Error: message_type (4) + version (2) + request_id + error_code + error_message
        self.response_parsers.insert(
            IncomingMessages::Error,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "request_id"),
                FieldDef::new(3, "error_code"),
                FieldDef::new(4, "error_message"),
            ])),
        );

        // ManagedAccounts: message_type (15) + version (1) + accounts (comma-separated)
        self.response_parsers.insert(
            IncomingMessages::ManagedAccounts,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "accounts"),
            ])),
        );

        // Position: message_type (61) + version + account + contract fields...
        self.response_parsers.insert(
            IncomingMessages::Position,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "account"),
                FieldDef::new(3, "contract_id"),
                FieldDef::new(4, "symbol"),
                FieldDef::new(5, "security_type"),
                FieldDef::new(6, "last_trade_date_or_contract_month"),
                FieldDef::new(7, "strike"),
                FieldDef::new(8, "right"),
                FieldDef::new(9, "multiplier"),
                FieldDef::new(10, "exchange"),
                FieldDef::new(11, "currency"),
                FieldDef::new(12, "local_symbol"),
                FieldDef::new(13, "trading_class"),
                FieldDef::new(14, "position"),
                FieldDef::new(15, "average_cost"),
            ])),
        );

        // PositionEnd: message_type (62) + version
        self.response_parsers.insert(
            IncomingMessages::PositionEnd,
            Box::new(FieldBasedParser::new(vec![FieldDef::new(0, "message_type"), FieldDef::new(1, "version")])),
        );

        // AccountSummary: message_type (63) + version + request_id + account + tag + value + currency
        self.response_parsers.insert(
            IncomingMessages::AccountSummary,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "request_id"),
                FieldDef::new(3, "account"),
                FieldDef::new(4, "tag"),
                FieldDef::new(5, "value"),
                FieldDef::new(6, "currency"),
            ])),
        );

        // AccountSummaryEnd: message_type (64) + version + request_id
        self.response_parsers.insert(
            IncomingMessages::AccountSummaryEnd,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "version"),
                FieldDef::new(2, "request_id"),
            ])),
        );

        // PnL: message_type (94) + request_id + daily_pnl + unrealized_pnl (optional) + realized_pnl (optional)
        self.response_parsers.insert(
            IncomingMessages::PnL,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
                FieldDef::new(2, "daily_pnl"),
                FieldDef::new(3, "unrealized_pnl"),
                FieldDef::new(4, "realized_pnl"),
            ])),
        );

        // PnLSingle: message_type (95) + request_id + position + daily_pnl + unrealized_pnl (optional) + realized_pnl (optional) + value
        self.response_parsers.insert(
            IncomingMessages::PnLSingle,
            Box::new(FieldBasedParser::new(vec![
                FieldDef::new(0, "message_type"),
                FieldDef::new(1, "request_id"),
                FieldDef::new(2, "position"),
                FieldDef::new(3, "daily_pnl"),
                FieldDef::new(4, "unrealized_pnl"),
                FieldDef::new(5, "realized_pnl"),
                FieldDef::new(6, "value"),
            ])),
        );
    }

    /// Parse an outbound message into human-readable fields.
    pub fn parse_request(&self, msg_type: OutgoingMessages, parts: &[&str]) -> Vec<ParsedField> {
        if let Some(parser) = self.request_parsers.get(&msg_type) {
            parser.parse(parts)
        } else {
            parse_generic_message(parts)
        }
    }

    /// Parse an inbound message into human-readable fields.
    pub fn parse_response(&self, msg_type: IncomingMessages, parts: &[&str]) -> Vec<ParsedField> {
        if let Some(parser) = self.response_parsers.get(&msg_type) {
            parser.parse(parts)
        } else {
            parse_generic_message(parts)
        }
    }

    /// Register a custom request parser
    pub fn register_request_parser(&mut self, msg_type: OutgoingMessages, parser: Box<dyn MessageParser>) {
        self.request_parsers.insert(msg_type, parser);
    }

    /// Register a custom response parser
    pub fn register_response_parser(&mut self, msg_type: IncomingMessages, parser: Box<dyn MessageParser>) {
        self.response_parsers.insert(msg_type, parser);
    }
}

impl Default for MessageParserRegistry {
    fn default() -> Self {
        Self::new()
    }
}

/// Parse a message generically when no specific parser is available
pub fn parse_generic_message(parts: &[&str]) -> Vec<ParsedField> {
    let mut fields = Vec::new();

    // First field is always message type
    if let Some(msg_type) = parts.first() {
        fields.push(ParsedField {
            name: "message_type".to_string(),
            value: msg_type.to_string(),
        });
    }

    // Remaining fields are generic
    for (i, part) in parts.iter().skip(1).enumerate() {
        // Skip the last empty part if it exists (from trailing \0)
        if i == parts.len() - 2 && part.is_empty() {
            continue;
        }
        fields.push(ParsedField {
            name: format!("field_{}", i + 2),
            value: part.to_string(),
        });
    }

    fields
}