ibapi 5.0.0

An unofficial Rust client for the Interactive Brokers TWS API. 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

//! A prelude module for convenient importing of commonly used types and traits.
//!
//! This module re-exports the most frequently used types from the ibapi crate
//! to simplify imports in user code. Instead of importing each type individually:
//!
//! ```rust
//! # #![allow(unused_imports)]
//! use ibapi::client::Client;
//! use ibapi::contracts::Contract;
//! use ibapi::orders::{Action, PlaceOrder};
//! use ibapi::market_data::historical::{BarSize, WhatToShow, ToDuration};
//! ```
//!
//! You can simply use:
//!
//! ```rust
//! # #![allow(unused_imports)]
//! use ibapi::prelude::*;
//! ```
//!
//! ## Type naming: `BarSize` and `WhatToShow`
//!
//! Both `market_data::historical` and `market_data::realtime` define their own
//! `WhatToShow` enum (different variant sets — realtime's is a subset of
//! historical's). Only `market_data::historical` has a `BarSize`; real-time
//! bars are always 5 seconds. Two canonical spellings depending on import
//! style:
//!
//! - **Prelude (flat) imports** — use the disambiguated names
//!   `HistoricalBarSize` / `HistoricalWhatToShow` / `RealtimeWhatToShow`.
//!   These are the canonical names for `use ibapi::prelude::*;` callers.
//! - **Module-qualified imports** — use the short names directly:
//!   `use ibapi::market_data::historical::{BarSize, WhatToShow};` or
//!   `use ibapi::market_data::realtime::WhatToShow;`. The module path
//!   provides the namespace; the short name is idiomatic Rust.
//!
//! Both spellings refer to the same type — the prelude entries are `pub use`
//! re-exports with `as` aliasing, not separate types.

// Core client
pub use crate::Client;
pub use crate::ClientBuilder;
pub use crate::Error;
pub use crate::{ConnectivityStatus, Notice, NoticeCategory};

// Contract types
pub use crate::contracts::{BondIdentifier, ContractMonth, Currency, Cusip, Exchange, ExpirationDate, Isin, LegAction, OptionRight, Strike, Symbol};
pub use crate::contracts::{Contract, OptionChainBuilder, SecurityType};

// Market data types - historical
pub use crate::market_data::historical::{
    BarSize as HistoricalBarSize, HistoricalDataBuilder, HistoricalScheduleBuilder, HistoricalTicksBuilder, ToDuration,
    WhatToShow as HistoricalWhatToShow,
};

// Market data types - realtime
pub use crate::market_data::realtime::{
    MarketDataBuilder, MarketDepthBuilder, RealtimeBarsBuilder, TickByTickBuilder, TickTypes, WhatToShow as RealtimeWhatToShow,
};
pub use crate::market_data::{IgnoreSize, MarketDataType, SmartDepth, TradingHours};

// Order types
pub use crate::orders::{order_builder, Action, ExecutionFilter, ExecutionFilterSide, ExecutionSide, OrderUpdate, Orders, PlaceOrder};

// Account types
pub use crate::accounts::types::{AccountGroup, AccountId, ContractId, ModelCode};
pub use crate::accounts::{
    AccountSummaryResult, AccountSummaryTags, AccountUpdate, AccountUpdateMulti, FamilyCode, PnL, PnLSingle, PositionUpdate, PositionUpdateMulti,
};

// Subscription types (canonical home: crate::subscriptions)
#[cfg(feature = "async")]
pub use crate::subscriptions::SubscriptionItemStreamExt;
pub use crate::subscriptions::{Drained, NoticeStream, Subscription, SubscriptionItem};

// Async-specific imports
#[cfg(feature = "async")]
pub use futures::StreamExt;