• C#
  • Java
  • VB
  • C++
  • Python
Contact us
Package IBApi

Classes

class  EClient
 TWS/Gateway client class This client class contains all the available methods to communicate with IB. Up to thirty-two clients can be connected to a single instance of the TWS/Gateway simultaneously. From herein, the TWS/Gateway will be referred to as the Host. More...
 
interface  EWrapper
 This interface's methods are used by the TWS/Gateway to communicate with the API client. Every API client application needs to implement this interface in order to handle all the events generated by the TWS/Gateway. Almost every EClientSocket method call will result in at least one event delivered here. More...
 
class  EReader
 Captures incoming messages to the API client and places them into a queue. More...
 
interface  EReaderSignal
 Notifies the thread reading information from the TWS whenever there are messages ready to be consumed. Not currently used in Python API. More...
 
class  EClientSocket
 TWS/Gateway client class This client class contains all the available methods to communicate with IB. Up to 32 clients can be connected to a single instance of the TWS/Gateway simultaneously. From herein, the TWS/Gateway will be referred to as the Host. More...
 
class  AccountSummaryTags
 class containing all existing values being reported by EClientSocket::reqAccountSummary More...
 
class  ComboLeg
 Class representing a leg within combo orders. More...
 
class  CommissionReport
 class representing the commissions generated by an execution. More...
 
class  Contract
 class describing an instrument's definition More...
 
class  ContractDetails
 extended contract details. More...
 
class  CFundDistributionPolicyIndicator
 
class  CFundAssetType
 
class  DeltaNeutralContract
 Delta-Neutral Contract. More...
 
class  EClientErrors
 Contains all possible errors occurring on the client side. This errors are not sent by the TWS but rather generated as the result of malfunction within the TWS API client. More...
 
class  CodeMsgPair
 associates error code and error message as a pair. More...
 
class  Liquidity
 Class describing the liquidity type of an execution. More...
 
class  Execution
 Class describing an order's execution. More...
 
class  ExecutionCondition
 This class represents a condition requiring a specific execution event to be fulfilled. Orders can be activated or canceled if a set of given conditions is met. An ExecutionCondition is met whenever a trade occurs on a certain product at the given exchange. More...
 
class  ExecutionFilter
 when requesting executions, a filter can be specified to receive only a subset of them More...
 
class  Order
 The order's description. More...
 
class  OrderComboLeg
 Allows to specify a price on an order's leg. More...
 
class  OrderState
 Provides an active order's current state. More...
 
class  PercentChangeCondition
 Used with conditional orders to place or submit an order based on a percentage change of an instrument to the last close price. More...
 
class  CTriggerMethod
 
class  PriceCondition
 Used with conditional orders to cancel or submit order based on price of an instrument. More...
 
class  ScannerSubscription
 Defines a market scanner request. More...
 
class  SoftDollarTier
 A container for storing Soft Dollar Tier information. More...
 
class  TagValue
 Convenience class to define key-value pairs. More...
 
class  TimeCondition
 Time condition used in conditional orders to submit or cancel orders at specified time. More...
 
class  VolumeCondition
 Used with conditional orders to submit or cancel an order based on a specified volume change in a security. More...
 
class  TickAttrib
 Tick attributes that describes additional information for price ticks. More...
 
class  Bar
 The historical data bar's description. More...
 
class  HistoricalTick
 The historical tick's description. Used when requesting historical tick data with whatToShow = MIDPOINT. More...
 
class  HistoricalTickBidAsk
 The historical tick's description. Used when requesting historical tick data with whatToShow = BID_ASK. More...
 
class  HistoricalTickLast
 The historical last tick's description. Used when requesting historical tick data with whatToShow = TRADES. More...
 

Enumerations

enum  FundDistributionPolicyIndicator { None, AccumulationFund, IncomeFund }
 
enum  FundAssetType {
  None, Others, MoneyMarket, FixedIncome,
  MultiAsset, Equity, Sector, Guaranteed,
  Alternative
}
 
enum  TriggerMethod {
  Default = 0, DoubleBidAsk, Last, DoubleLast,
  BidAsk, LastOfBidAsk = 7, MidPoint
}