• C#
  • Java
  • VB
  • C++
  • Python
Contact us
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
\NIBApi
 oCEClientTWS/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
 oCEWrapperThis 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
 oCEReaderCaptures incoming messages to the API client and places them into a queue
 oCEReaderSignalNotifies the thread reading information from the TWS whenever there are messages ready to be consumed. Not currently used in Python API
 oCEClientSocketTWS/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
 oCAccountSummaryTagsClass containing all existing values being reported by EClientSocket::reqAccountSummary
 oCComboLegClass representing a leg within combo orders
 oCCommissionReportClass representing the commissions generated by an execution
 oCContractClass describing an instrument's definition
 oCContractDetailsExtended contract details
 oCDeltaNeutralContractDelta-Neutral Contract
 oCEClientErrorsContains 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
 oCCodeMsgPairAssociates error code and error message as a pair
 oCLiquidityClass describing the liquidity type of an execution
 oCExecutionClass describing an order's execution
 oCExecutionConditionThis 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
 oCExecutionFilterWhen requesting executions, a filter can be specified to receive only a subset of them
 oCOrderThe order's description
 oCOrderComboLegAllows to specify a price on an order's leg
 oCOrderStateProvides an active order's current state
 oCPercentChangeConditionUsed with conditional orders to place or submit an order based on a percentage change of an instrument to the last close price
 oCPriceConditionUsed with conditional orders to cancel or submit order based on price of an instrument
 oCScannerSubscriptionDefines a market scanner request
 oCSoftDollarTierA container for storing Soft Dollar Tier information
 oCTagValueConvenience class to define key-value pairs
 oCTimeConditionTime condition used in conditional orders to submit or cancel orders at specified time
 oCVolumeConditionUsed with conditional orders to submit or cancel an order based on a specified volume change in a security
 oCTickAttribTick attributes that describes additional information for price ticks
 oCBarThe historical data bar's description
 oCHistoricalTickThe historical tick's description. Used when requesting historical tick data with whatToShow = MIDPOINT
 oCHistoricalTickBidAskThe historical tick's description. Used when requesting historical tick data with whatToShow = BID_ASK
 \CHistoricalTickLastThe historical last tick's description. Used when requesting historical tick data with whatToShow = TRADES