For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Requests all current open orders in associated accounts at the current moment. The existing orders will be received via the openOrder and orderStatus events. Open orders are returned once; this function does not initiate a subscription. More…
reqAutoOpenOrders (bool autoBind)
void
Requests status updates about future orders placed from TWS. Can only be used with client ID 0. More…
reqContractDetails (int reqId
void
Contract contract)
None
This method will provide all the contracts matching the contract provided. It can also be used to retrieve complete options and futures chains. This information will be returned at EWrapper:contractDetails. Though it is now (in API version > 9.72.12) advised to use reqSecDefOptParams for that purpose.
None
None
. More…
None
reqCurrentTime ()
void
Requests TWS’s current time. More…
reqExecutions (int reqId
void
ExecutionFilter filter)
reqFundamentalData (int reqId
void
Contract contract
reqGlobalCancel ()
void
Cancels all active orders.
None
This method will cancel ALL open orders including those placed directly from TWS. More…
None
reqHistoricalData (int tickerId
void
Contract contract
reqIds (int numIds)
void
Requests the next valid order ID at the current moment. More…
reqManagedAccts ()
void
Requests the accounts to which the logged user has access to. More…
reqMktData (int tickerId
void
Contract contract
reqMarketDataType (int marketDataType)
void
Switches data type returned from reqMktData request to “frozen”
None
The API can receive frozen market data from Trader Workstation. Frozen market data is the last data recorded in our system.
None
the API receives real-time market data. Invoking this function with argument 2 requests a switch to frozen data immediately or after the close.
During normal trading hours
None
the market data type will automatically switch back to real time if available. More…
When the market reopens
None
reqMarketDepth (int tickerId
void
Contract contract
commissions
This request must be direct-routed to an exchange and not smart-routed. The number of simultaneous market depth requests allowed in an account is calculated based on a formula that looks at an accounts equity
and quote booster packs. More…
reqNewsBulletins (bool allMessages)
void
Subscribes to IB’s News Bulletins. More…
reqOpenOrders ()
void
Requests all open orders places by this specific API client (identified by the API client id). For client ID 0
reqPositions ()
void
Subscribes to position updates for all accessible accounts. All positions sent initially
reqRealTimeBars (int tickerId
void
Contract contract
only 5 seconds bars are provided. This request is subject to the same pacing as any historical data request: no more than 60 API queries in more than 600 seconds.
Currently
None
None
Real time bars subscriptions are also included in the calculation of the number of Level 1 market data subscriptions allowed in an account. More…
None
reqScannerParameters ()
void
Requests an XML list of scanner parameters valid in TWS.
None
Not all parameters are valid from API scanner. More…
None
reqScannerSubscription (int reqId
void
ScannerSubscription subscription
reqScannerSubscription (int reqId
void
ScannerSubscription subscription
setServerLogLevel (int logLevel)
void
Changes the TWS/GW log level. The default is 2 = ERROR
None
5 = DETAIL is required for capturing all API messages and troubleshooting API programs
None
None
Valid values are:
None
None
1 = SYSTEM
None
None
2 = ERROR
None
None
3 = WARNING
None
None
4 = INFORMATION
None
None
5 = DETAIL
None
None
.
None
verifyRequest (string apiName
void
string apiVersion)
verifyMessage (string apiData)
void
For IB’s internal purpose. Allows to provide means of verification between the TWS and third party programs.
verifyAndAuthRequest (string apiName
void
string apiVersion
verifyAndAuthMessage (string apiData
void
string xyzResponse)
queryDisplayGroups (int requestId)
void
Requests all available Display Groups in TWS. More…
subscribeToGroupEvents (int requestId
void
int groupId)
updateDisplayGroup (int requestId
void
string contractInfo)
unsubscribeFromGroupEvents (int requestId)
void
Cancels a TWS Window Group subscription.
reqPositionsMulti (int requestId
void
string account
cancelPositionsMulti (int requestId)
void
Cancels positions request for account and/or model. More…
reqAccountUpdatesMulti (int requestId
void
string account
cancelAccountUpdatesMulti (int requestId)
void
Cancels account updates request for account and/or model. More…
Requests venues for which market data is returned to updateMktDepthL2 (those with market makers) More…
reqSmartComponents (int reqId
void
string bboExchange)
reqNewsProviders ()
void
Requests news providers which the user has subscribed to. More…
reqNewsArticle (int requestId
void
string providerCode
reqHistoricalNews (int requestId
void
int conId
reqHeadTimestamp (int tickerId
void
Contract contract
cancelHeadTimestamp (int tickerId)
void
Cancels a pending reqHeadTimeStamp request
None
. More…
None
reqHistogramData (int tickerId
void
Contract contract
None
. More…
None
cancelHistogramData (int tickerId)
void
Cancels an active data histogram request. More…
reqMarketRule (int marketRuleId)
void
Requests details about a given market rule
None
The market rule for an instrument on a particular exchange provides details about how the minimum price increment changes with price
None
None
A list of market rule ids can be obtained by invoking reqContractDetails on a particular contract. The returned market rule ID list will provide the market rule ID for the instrument in the correspond valid exchange list in contractDetails.
None
None
. More…
None
reqPnL (int reqId
void
string account
cancelPnL (int reqId)
void
cancels subscription for real time updated daily PnL params reqId
reqPnLSingle (int reqId
void
string account
cancelPnLSingle (int reqId)
void
Cancels real time subscription for a positions daily PnL information. More…
