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
410
411
412
413
414
415
416
417
418
419
420
use crate::contracts::{Contract, Currency, Exchange, Symbol};
use crate::errors::Error;
use crate::orders::builder::tests::async_mock_client::mock::AsyncMockClient;
use crate::orders::builder::{BracketOrderBuilder, BracketOrderIds, OrderBuilder, OrderId};
use crate::orders::{Action, Order, OrderData, OrderState, OrderStatus, OrderUpdate, PlaceOrder};
use futures::{Stream, StreamExt};
use std::pin::Pin;

fn create_stock_contract(symbol: &str) -> Contract {
    Contract {
        symbol: Symbol::from(symbol),
        security_type: crate::contracts::SecurityType::Stock,
        exchange: Exchange::from("SMART"),
        currency: Currency::from("USD"),
        ..Default::default()
    }
}

// Mock the orders module functions for testing
mod orders {
    use super::*;
    use futures::Stream;
    use std::pin::Pin;

    pub async fn submit_order(client: &AsyncMockClient, order_id: i32, contract: &Contract, order: &Order) -> Result<(), Error> {
        client.submit_order(order_id, contract, order).await
    }

    pub async fn place_order(
        client: &AsyncMockClient,
        order_id: i32,
        contract: &Contract,
        order: &Order,
    ) -> Result<Pin<Box<dyn Stream<Item = Result<PlaceOrder, Error>> + Send>>, Error> {
        client.place_order(order_id, contract, order).await
    }
}

// Implement the async methods for MockClient
impl<'a> OrderBuilder<'a, AsyncMockClient> {
    /// Build the order and return it without submitting
    pub fn build_order(self) -> Result<Order, Error> {
        self.build().map_err(Into::into)
    }

    /// Submit the order using async mock client
    pub async fn submit(self) -> Result<OrderId, Error> {
        let client = self.client;
        let contract = self.contract;
        let order_id = client.next_order_id();
        let order = self.build()?;
        orders::submit_order(client, order_id, contract, &order).await?;
        Ok(OrderId::new(order_id))
    }

    /// Analyze order for margin/commission (what-if)
    pub async fn analyze(mut self) -> Result<OrderState, Error> {
        self.what_if = true;
        let client = self.client;
        let contract = self.contract;
        let order_id = client.next_order_id();
        let order = self.build()?;

        // Submit what-if order and get the response
        let mut subscription = orders::place_order(client, order_id, contract, &order).await?;

        // Look for the order state in the responses
        while let Some(Ok(response)) = subscription.next().await {
            if let PlaceOrder::OpenOrder(order_data) = response {
                if order_data.order_id == order_id {
                    return Ok(order_data.order_state);
                }
            }
        }

        Err(Error::Simple("What-if analysis did not return order state".to_string()))
    }

    /// Submit order and return a stream of updates
    pub async fn submit_with_updates(self) -> Result<Pin<Box<dyn Stream<Item = OrderUpdate> + Send>>, Error> {
        let client = self.client;
        let contract = self.contract;
        let order_id = client.next_order_id();
        let order = self.build()?;

        // Use the mock client's submit_order_with_updates method
        client.submit_order_with_updates(order_id, contract, &order).await
    }
}

// Implement submit_all for bracket orders
impl<'a> BracketOrderBuilder<'a, AsyncMockClient> {
    /// Submit the bracket order trio asynchronously and return the generated identifiers.
    pub async fn submit_all(self) -> Result<BracketOrderIds, Error> {
        let client = self.parent_builder.client;
        let contract = self.parent_builder.contract;
        let base_id = client.next_order_id();
        let orders = self.build()?;

        let mut order_ids = Vec::new();

        for (i, mut order) in orders.into_iter().enumerate() {
            let order_id = base_id + i as i32;
            order.order_id = order_id;
            order_ids.push(order_id);

            // Update parent_id for child orders
            if i > 0 {
                order.parent_id = base_id;
            }

            // Only transmit the last order
            if i == 2 {
                order.transmit = true;
            }

            orders::submit_order(client, order_id, contract, &order).await?;
        }

        Ok(BracketOrderIds::new(order_ids[0], order_ids[1], order_ids[2]))
    }
}

#[tokio::test]
async fn test_async_order_submit() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    client.set_next_order_id(100);

    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(50.00);

    let order_id = builder.submit().await.unwrap();
    assert_eq!(order_id.value(), 100);

    // Verify the order was submitted
    let submitted = client.get_submitted_orders();
    assert_eq!(submitted.len(), 1);
    assert_eq!(submitted[0].0, 100);
    assert_eq!(submitted[0].2.action, Action::Buy);
    assert_eq!(submitted[0].2.total_quantity, 100.0);
    assert_eq!(submitted[0].2.order_type, "LMT");
    assert_eq!(submitted[0].2.limit_price, Some(50.00));
}

#[tokio::test]
async fn test_async_order_analyze() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Set up a custom response for what-if analysis
    let order_state = OrderState {
        commission: Some(2.50),
        initial_margin_before: Some(20000.00),
        initial_margin_after: Some(25000.00),
        maintenance_margin_before: Some(15000.00),
        maintenance_margin_after: Some(18000.00),
        ..Default::default()
    };

    client.add_place_order_response(vec![PlaceOrder::OpenOrder(OrderData {
        order_id: 100,
        contract: contract.clone(),
        order: Default::default(),
        order_state: order_state.clone(),
    })]);

    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(50.00);

    let analysis = builder.analyze().await.unwrap();
    assert_eq!(analysis.commission, Some(2.50));
    assert_eq!(analysis.initial_margin_before, Some(20000.00));
    assert_eq!(analysis.initial_margin_after, Some(25000.00));
    assert_eq!(analysis.maintenance_margin_before, Some(15000.00));
    assert_eq!(analysis.maintenance_margin_after, Some(18000.00));

    // Verify what-if flag was set
    let submitted = client.get_submitted_orders();
    assert_eq!(submitted.len(), 1);
    assert!(submitted[0].2.what_if);
}

#[tokio::test]
async fn test_async_bracket_order_submit_all() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    client.set_next_order_id(200);

    let bracket_builder = OrderBuilder::new(&client, &contract)
        .buy(100)
        .bracket()
        .entry_limit(50.0)
        .take_profit(55.0)
        .stop_loss(45.0);

    let bracket_ids = bracket_builder.submit_all().await.unwrap();
    assert_eq!(bracket_ids.parent.value(), 200);
    assert_eq!(bracket_ids.take_profit.value(), 201);
    assert_eq!(bracket_ids.stop_loss.value(), 202);

    // Verify three orders were submitted
    let submitted = client.get_submitted_orders();
    assert_eq!(submitted.len(), 3);

    // Check parent order
    assert_eq!(submitted[0].0, 200);
    assert_eq!(submitted[0].2.action, Action::Buy);
    assert_eq!(submitted[0].2.order_type, "LMT");
    assert_eq!(submitted[0].2.limit_price, Some(50.0));
    assert!(!submitted[0].2.transmit);

    // Check take profit order
    assert_eq!(submitted[1].0, 201);
    assert_eq!(submitted[1].2.action, Action::Sell);
    assert_eq!(submitted[1].2.order_type, "LMT");
    assert_eq!(submitted[1].2.limit_price, Some(55.0));
    assert_eq!(submitted[1].2.parent_id, 200);
    assert!(!submitted[1].2.transmit);

    // Check stop loss order
    assert_eq!(submitted[2].0, 202);
    assert_eq!(submitted[2].2.action, Action::Sell);
    assert_eq!(submitted[2].2.order_type, "STP");
    assert_eq!(submitted[2].2.aux_price, Some(45.0));
    assert_eq!(submitted[2].2.parent_id, 200);
    assert!(submitted[2].2.transmit);
}

#[tokio::test]
async fn test_async_submit_oca_orders() {
    let client = AsyncMockClient::new();
    let contract1 = create_stock_contract("AAPL");
    let contract2 = create_stock_contract("MSFT");

    client.set_next_order_id(300);

    let order1 = OrderBuilder::new(&client, &contract1)
        .buy(100)
        .limit(50.0)
        .oca_group("TestOCA", 1)
        .build_order()
        .unwrap();

    let order2 = OrderBuilder::new(&client, &contract2)
        .buy(100)
        .limit(45.0)
        .oca_group("TestOCA", 1)
        .build_order()
        .unwrap();

    let order_ids = client.submit_oca_orders(vec![(contract1, order1), (contract2, order2)]).await.unwrap();

    assert_eq!(order_ids.len(), 2);
    assert_eq!(order_ids[0].value(), 300);
    assert_eq!(order_ids[1].value(), 301);

    // Verify OCA orders were submitted
    let submitted = client.get_submitted_orders();
    assert_eq!(submitted.len(), 2);
    assert_eq!(submitted[0].2.oca_group, "TestOCA");
    assert_eq!(submitted[1].2.oca_group, "TestOCA");
}

#[tokio::test]
async fn test_async_order_submit_with_error() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Set up an error response
    client.add_submit_order_response(Err(Error::Simple("Order rejected".to_string())));

    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(50.00);

    let result = builder.submit().await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("Order rejected"));
}

#[tokio::test]
async fn test_async_analyze_no_response() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Set up empty response (no order state)
    client.add_place_order_response(vec![]);

    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(50.00);

    let result = builder.analyze().await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("What-if analysis did not return order state"));
}

#[tokio::test]
async fn test_async_order_update_stream() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Set up order update stream
    client.add_order_update_stream(vec![
        OrderUpdate::OrderStatus(OrderStatus {
            order_id: 100,
            status: "PendingSubmit".to_string(),
            filled: 0.0,
            remaining: 100.0,
            average_fill_price: 0.0,
            perm_id: 12345,
            parent_id: 0,
            last_fill_price: 0.0,
            client_id: 0,
            why_held: String::new(),
            market_cap_price: 0.0,
        }),
        OrderUpdate::OrderStatus(OrderStatus {
            order_id: 100,
            status: "Submitted".to_string(),
            filled: 0.0,
            remaining: 100.0,
            average_fill_price: 0.0,
            perm_id: 12345,
            parent_id: 0,
            last_fill_price: 0.0,
            client_id: 0,
            why_held: String::new(),
            market_cap_price: 0.0,
        }),
        OrderUpdate::OrderStatus(OrderStatus {
            order_id: 100,
            status: "Filled".to_string(),
            filled: 100.0,
            remaining: 0.0,
            average_fill_price: 50.00,
            perm_id: 12345,
            parent_id: 0,
            last_fill_price: 50.00,
            client_id: 0,
            why_held: String::new(),
            market_cap_price: 0.0,
        }),
    ]);

    client.set_next_order_id(100);

    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(50.00);

    let mut update_stream = builder.submit_with_updates().await.unwrap();

    // Collect all updates
    let mut updates = Vec::new();
    while let Some(update) = update_stream.next().await {
        updates.push(update);
    }

    assert_eq!(updates.len(), 3);

    // Check status progression
    if let OrderUpdate::OrderStatus(status) = &updates[0] {
        assert_eq!(status.status, "PendingSubmit");
    }

    if let OrderUpdate::OrderStatus(status) = &updates[1] {
        assert_eq!(status.status, "Submitted");
    }

    if let OrderUpdate::OrderStatus(status) = &updates[2] {
        assert_eq!(status.status, "Filled");
        assert_eq!(status.filled, 100.0);
        assert_eq!(status.average_fill_price, 50.00);
    }
}

#[tokio::test]
async fn test_async_complex_order_types() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Test trailing stop order
    let builder = OrderBuilder::new(&client, &contract).sell(100).trailing_stop(5.0, 95.0);

    let _order_id = builder.submit().await.unwrap();
    let submitted = client.get_submitted_orders();
    assert_eq!(submitted[0].2.order_type, "TRAIL");
    assert_eq!(submitted[0].2.trailing_percent, Some(5.0));
    assert_eq!(submitted[0].2.trail_stop_price, Some(95.0));

    // Test algo order
    let builder = OrderBuilder::new(&client, &contract)
        .buy(100)
        .limit(50.00)
        .algo("VWAP")
        .algo_param("startTime", "09:30:00")
        .algo_param("endTime", "16:00:00");

    builder.submit().await.unwrap();
    let submitted = client.get_submitted_orders();
    let last = submitted.last().unwrap();
    assert_eq!(last.2.algo_strategy, "VWAP");
    assert_eq!(last.2.algo_params.len(), 2);
}

#[tokio::test]
async fn test_async_order_validation() {
    let client = AsyncMockClient::new();
    let contract = create_stock_contract("AAPL");

    // Test invalid quantity
    let builder = OrderBuilder::new(&client, &contract).buy(-100).market();

    let result = builder.submit().await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("Invalid quantity"));

    // Test invalid price (NaN)
    let builder = OrderBuilder::new(&client, &contract).buy(100).limit(f64::NAN);

    let result = builder.submit().await;
    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("Invalid price"));
}