• C#
  • Java
  • VB
  • C++
  • Python
Contact us
ContractDetails Class Reference

extended contract details. More...

Public Member Functions

 ContractDetails (Contract summary, String marketName, double minTick, String orderTypes, String validExchanges, int underConId, String longName, String contractMonth, String industry, String category, String subcategory, String timeZoneId, String tradingHours, String liquidHours, String evRule, double evMultiplier)
 

Properties

Contract Summary [get, set]
 A Contract object summarising this product.
 
string MarketName [get, set]
 The market name for this product.
 
double MinTick [get, set]
 The minimum allowed price variation. Note that many securities vary their minimum tick size according to their price. This value will only show the smallest of the different minimum tick sizes regardless of the product's price. Full information about the minimum increment at a particular price and exchange is only available from the IB Contract and Security Search site.
 
int PriceMagnifier [get, set]
 Allows execution and strike prices to be reported consistently with market data, historical data and the order price, i.e. Z on LIFFE is reported in Index points and not GBP.
 
string OrderTypes [get, set]
 Supported order types for this product.
 
string ValidExchanges [get, set]
 Valid exchange fields when placing an order for this contract.
 
int UnderConId [get, set]
 Underlying's contract Id.
 
string LongName [get, set]
 Descriptive name of the product.
 
string ContractMonth [get, set]
 Typically the contract month of the underlying for a Future contract.
 
string Industry [get, set]
 The industry classification of the underlying/product. For example, Financial.
 
string Category [get, set]
 The industry category of the underlying. For example, InvestmentSvc.
 
string Subcategory [get, set]
 The industry subcategory of the underlying. For example, Brokerage.
 
string TimeZoneId [get, set]
 The ID of the time zone for the trading hours of the product. For example, EST.
 
string TradingHours [get, set]
 The trading hours of the product. This value will contain the trading hours of the current day as well as the next's. For example, 20090507:0700-1830,1830-2330;20090508:CLOSED.
 
string LiquidHours [get, set]
 The liquid hours of the product. This value will contain the liquid hours of the current day as well as the next's. For example, 20090507:0700-1830,1830-2330;20090508:CLOSED.
 
string EvRule [get, set]
 Contains the Economic Value Rule name and the respective optional argument. The two values should be separated by a colon. For example, aussieBond:YearsToExpiration=3. When the optional argument is not present, the first value will be followed by a colon.
 
double EvMultiplier [get, set]
 Tells you approximately how much the market value of a contract would change if the price were to change by 1. It cannot be used to get market value by multiplying the price by the approximate multiplier.
 
int MdSizeMultiplier [get, set]
 MD Size Multiplier. Returns the size multiplier for values returned to tickSize from a market data request. Generally 100 for US stocks and 1 for other instruments.
 
List< TagValueSecIdList [get, set]
 A list of contract identifiers that the customer is allowed to view. CUSIP/ISIN/etc. For US stocks, receiving the ISIN requires the CUSIP market data subscription.
 
string Cusip [get, set]
 The nine-character bond CUSIP or the 12-character SEDOL. For Bonds only. Receiving CUSIPs requires a CUSIP market data subscription.
 
string Ratings [get, set]
 Identifies the credit rating of the issuer. For Bonds only. A higher credit rating generally indicates a less risky investment. Bond ratings are from Moody's and S&P respectively. Not currently implemented due to bond market data restrictions.
 
string DescAppend [get, set]
 A description string containing further descriptive information about the bond. For Bonds only.
 
string BondType [get, set]
 The type of bond, such as "CORP.".
 
string CouponType [get, set]
 The type of bond coupon. For Bonds only.
 
bool Callable [get, set]
 If true, the bond can be called by the issuer under certain conditions. For Bonds only.
 
bool Putable [get, set]
 Values are True or False. If true, the bond can be sold back to the issuer under certain conditions. For Bonds only.
 
double Coupon [get, set]
 The interest rate used to calculate the amount you will receive in interest payments over the course of the year. For Bonds only.
 
bool Convertible [get, set]
 Values are True or False. If true, the bond can be converted to stock under certain conditions. For Bonds only.
 
string Maturity [get, set]
 he date on which the issuer must repay the face value of the bond. For Bonds only. Not currently implemented due to bond market data restrictions.
 
string IssueDate [get, set]
 The date the bond was issued. For Bonds only. Not currently implemented due to bond market data restrictions.
 
string NextOptionDate [get, set]
 Only if bond has embedded options. Refers to callable bonds and puttable bonds. Available in TWS description window for bonds.
 
string NextOptionType [get, set]
 Type of embedded option. Only if bond has embedded options.
 
bool NextOptionPartial [get, set]
 Only if bond has embedded options. For Bonds only.
 
string Notes [get, set]
 If populated for the bond in IB's database. For Bonds only.
 

Detailed Description

extended contract details.

See Also
Contract