Struct Contract 

pub struct Contract {

    pub contract_id: i32,
    pub symbol: Symbol,
    pub security_type: SecurityType,
    pub last_trade_date_or_contract_month: String,
    pub strike: f64,
    pub right: String,
    pub multiplier: String,
    pub exchange: Exchange,
    pub currency: Currency,
    pub local_symbol: String,
    pub primary_exchange: Exchange,
    pub trading_class: String,
    pub include_expired: bool,
    pub security_id_type: String,
    pub security_id: String,
    pub combo_legs_description: String,
    pub combo_legs: Vec<ComboLeg>,
    pub delta_neutral_contract: Option<DeltaNeutralContract>,
    pub issuer_id: String,
    pub description: String,
}

Contract describes an instrument’s definition

Fields

contract_id: i32

The unique IB contract identifier.

symbol: Symbol

The underlying’s asset symbol.

security_type: SecurityType

Type of security (stock, option, future, etc.).

last_trade_date_or_contract_month: String

The contract’s last trading day or contract month (for Options and Futures). Strings with format YYYYMM will be interpreted as the Contract Month whereas YYYYMMDD will be interpreted as Last Trading Day.

strike: f64

The option’s strike price.

right: String

Either Put or Call (i.e. Options). Valid values are P, PUT, C, CALL.

multiplier: String

The instrument’s multiplier (i.e. options, futures).

exchange: Exchange

The destination exchange.

currency: Currency

The underlying’s currency.

local_symbol: String

The contract’s symbol within its primary exchange For options, this will be the OCC symbol.

primary_exchange: Exchange

The contract’s primary exchange. For smart routed contracts, used to define contract in case of ambiguity. Should be defined as native exchange of contract, e.g. ISLAND for MSFT For exchanges which contain a period in name, will only be part of exchange name prior to period, i.e. ENEXT for ENEXT.BE.

trading_class: String

The trading class name for this contract. Available in TWS contract description window as well. For example, GBL Dec ’13 future’s trading class is “FGBL”.

include_expired: bool

If set to true, contract details requests and historical data queries can be performed pertaining to expired futures contracts. Expired options or other instrument types are not available.

security_id_type: String

Security’s identifier when querying contract’s details or placing orders ISIN - Example: Apple: US0378331005 CUSIP - Example: Apple: 037833100.

security_id: String

Identifier of the security type.

combo_legs_description: String

Description of the combo legs.

combo_legs: Vec<ComboLeg>

Individual legs composing a combo contract.

delta_neutral_contract: Option<DeltaNeutralContract>

Delta and underlying price for Delta-Neutral combo orders. Underlying (STK or FUT), delta and underlying price goes into this attribute.

issuer_id: String

Identifier of the issuer for bonds and structured products.

description: String

Human-readable description provided by TWS.

Implementations

impl Contract

pub fn stock(symbol: impl Into<Symbol>) -> StockBuilder<Symbol>

Creates a stock contract builder.

Examples

use ibapi::contracts::{Contract, Exchange, Currency};

// Simple stock
let aapl = Contract::stock("AAPL").build();

// Stock with customization
let toyota = Contract::stock("7203")
    .on_exchange("TSEJ")
    .in_currency("JPY")
    .build();

pub fn call( symbol: impl Into<Symbol>, ) -> OptionBuilder<Symbol, Missing, Missing>

Creates a call option contract builder.

Examples

use ibapi::contracts::Contract;

let call = Contract::call("AAPL")
    .strike(150.0)
    .expires_on(2024, 12, 20)
    .build();

pub fn put(symbol: impl Into<Symbol>) -> OptionBuilder<Symbol, Missing, Missing>

Creates a put option contract builder.

Examples

use ibapi::contracts::Contract;

let put = Contract::put("SPY")
    .strike(450.0)
    .expires_on(2024, 12, 20)
    .build();

pub fn futures(symbol: impl Into<Symbol>) -> FuturesBuilder<Symbol, Missing>

Creates a futures contract builder.

Examples

use ibapi::contracts::{Contract, ContractMonth};

let es = Contract::futures("ES")
    .expires_in(ContractMonth::new(2024, 3))
    .build();

pub fn forex( base: impl Into<Currency>, quote: impl Into<Currency>, ) -> ForexBuilder

Creates a forex contract builder.

Examples

use ibapi::contracts::{Contract, Currency};

let eur_usd = Contract::forex("EUR", "USD")
    .amount(100_000)
    .build();

pub fn crypto(symbol: impl Into<Symbol>) -> CryptoBuilder

Creates a crypto contract builder.

Examples

use ibapi::contracts::Contract;

let btc = Contract::crypto("BTC").build();

pub fn index(symbol: &str) -> Contract

Creates an index contract.

Examples

use ibapi::contracts::Contract;

let spx = Contract::index("SPX");

pub fn bond_cusip(cusip: impl Into<String>) -> Contract

Create a bond contract with CUSIP identifier

Example

use ibapi::contracts::Contract;

// US Treasury bond by CUSIP
let bond = Contract::bond_cusip("912810RN0");

pub fn bond_isin(isin: impl Into<String>) -> Contract

Create a bond contract with ISIN identifier

Example

use ibapi::contracts::Contract;

// European bond by ISIN
let bond = Contract::bond_isin("DE0001102309");

pub fn bond(identifier: BondIdentifier) -> Contract

Create a bond contract with CUSIP or ISIN identifier

Example

use ibapi::contracts::{Contract, BondIdentifier, Cusip, Isin};

// US Treasury bond by CUSIP
let bond = Contract::bond(BondIdentifier::Cusip(Cusip::new("912810RN0")));

// European bond by ISIN
let bond = Contract::bond(BondIdentifier::Isin(Isin::new("DE0001102309")));

pub fn spread() -> SpreadBuilder

Creates a spread/combo contract builder.

Examples

use ibapi::contracts::{Contract, LegAction};

let spread = Contract::spread()
    .calendar(12345, 67890)
    .build();

pub fn news(provider_code: &str) -> Contract

Creates a news contract from the specified provider code.

Examples

use ibapi::contracts::{Contract, Symbol, Exchange};

let news = Contract::news("BRFG");
assert_eq!(news.symbol, Symbol::from("BRFG:BRFG_ALL"));
assert_eq!(news.exchange, Exchange::from("BRFG"));

pub fn option( symbol: &str, expiration_date: &str, strike: f64, right: &str, ) -> Contract

Creates an option contract from the specified parameters.

Currency defaults to USD and exchange defaults to SMART.

Arguments

• symbol - Symbol of the underlying asset
• expiration_date - Expiration date of option contract (YYYYMMDD)
• strike - Strike price of the option contract
• right - Option type: “C” for Call, “P” for Put

Examples

use ibapi::contracts::{Contract, Symbol};

let call = Contract::option("AAPL", "20240119", 150.0, "C");
assert_eq!(call.symbol, Symbol::from("AAPL"));
assert_eq!(call.strike, 150.0);
assert_eq!(call.right, "C");

Creates a simple option contract (for backward compatibility). For new code, use Contract::call() or Contract::put() builders instead.

pub fn is_bag(&self) -> bool

Returns true if this contract represents a bag/combo order.

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Contract

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Contract

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Contract

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Contract

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Contract

fn eq(&self, other: &Contract) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Contract

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Contract