ibapi 5.4.0

An unofficial Rust client for the Interactive Brokers TWS API: market data, orders, and account data, with async (Tokio) and blocking clients for TWS and IB Gateway.
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

use super::*;
use crate::client::ids::REQUEST_ID_FLOOR;
use crate::orders::WhatIfType;

fn assert_rejected(result: Result<OrderId, Error>, what: &str) {
    assert!(matches!(result, Err(Error::OrderIdInRequestRange { .. })), "{what}: {result:?}");
}

#[test]
fn verify_order_ids_accepts_order_range() {
    let order = Order {
        parent_id: 7,
        preset_stop_loss_order_id: Some(8),
        preset_profit_taker_order_id: Some(9),
        ..Order::default()
    };
    assert_eq!(
        verify_order_ids(OrderId::from(REQUEST_ID_FLOOR - 1), &order).unwrap(),
        OrderId::from(REQUEST_ID_FLOOR - 1)
    );
    // `parent_id` 0 means no parent.
    assert!(verify_order_ids(OrderId::from(1), &Order::default()).is_ok());
}

/// Every order id an `Order` carries is checked: TWS routes frames for the
/// attached orders by their ids (#789).
#[test]
fn verify_order_ids_rejects_request_range() {
    let floor = REQUEST_ID_FLOOR;
    assert_rejected(verify_order_ids(OrderId::from(floor), &Order::default()), "order id");

    let parent = Order {
        parent_id: floor,
        ..Order::default()
    };
    assert_rejected(verify_order_ids(OrderId::from(1), &parent), "parent_id");

    let stop_loss = Order {
        preset_stop_loss_order_id: Some(floor),
        ..Order::default()
    };
    assert_rejected(verify_order_ids(OrderId::from(1), &stop_loss), "preset_stop_loss_order_id");

    let profit_taker = Order {
        preset_profit_taker_order_id: Some(floor),
        ..Order::default()
    };
    assert_rejected(verify_order_ids(OrderId::from(1), &profit_taker), "preset_profit_taker_order_id");
}

/// Each field above the connection floor passes at its feature's minimum
/// server version and fails one below it with that feature's version and
/// message in the error.
#[test]
fn verify_order_gates_fields_above_the_floor() {
    let cases = [
        (
            "hedge_max_size",
            Order {
                hedge_max_size: Some(1),
                ..Order::default()
            },
            HEDGE_MAX_SIZE,
        ),
        (
            "deactivate",
            Order {
                deactivate: true,
                ..Order::default()
            },
            DEACTIVATE,
        ),
        (
            "post_only",
            Order {
                post_only: true,
                ..Order::default()
            },
            POST_ONLY,
        ),
        (
            "allow_pre_open",
            Order {
                allow_pre_open: true,
                ..Order::default()
            },
            ALLOW_PRE_OPEN,
        ),
        (
            "ignore_open_auction",
            Order {
                ignore_open_auction: true,
                ..Order::default()
            },
            IGNORE_OPEN_AUCTION,
        ),
        (
            "route_marketable_to_bbo",
            Order {
                route_marketable_to_bbo: true,
                ..Order::default()
            },
            ROUTE_MARKETABLE_TO_BBO,
        ),
        (
            "seek_price_improvement",
            Order {
                seek_price_improvement: Some(false),
                ..Order::default()
            },
            SEEK_PRICE_IMPROVEMENT,
        ),
        (
            "what_if_type",
            Order {
                what_if_type: Some(WhatIfType::FullOrderCheck),
                ..Order::default()
            },
            WHAT_IF_TYPE,
        ),
        (
            "preset_stop_loss_order_id",
            Order {
                preset_stop_loss_order_id: Some(8),
                ..Order::default()
            },
            ATTACHED_ORDERS,
        ),
        (
            "preset_profit_taker_order_id",
            Order {
                preset_profit_taker_order_id: Some(9),
                ..Order::default()
            },
            ATTACHED_ORDERS,
        ),
        (
            "conditions_include_overnight",
            Order {
                conditions_include_overnight: true,
                ..Order::default()
            },
            CONDITIONS_INCLUDE_OVERNIGHT,
        ),
    ];
    for (name, order, feature) in cases {
        assert!(verify_order(feature.min_version, &order).is_ok(), "{name} at its minimum version");
        match verify_order(feature.min_version - 1, &order) {
            Err(Error::ServerVersion(required, actual, message)) => assert_eq!(
                (required, actual, message.as_str()),
                (feature.min_version, feature.min_version - 1, feature.name),
                "{name}"
            ),
            other => panic!("{name} below its minimum version: {other:?}"),
        }
    }
    assert!(verify_order(server_versions::PROTOBUF_REST_MESSAGES_3, &Order::default()).is_ok());
}