ib_async.client

Generated from the installed ib_async 2.1.0 package. Signatures and defaults are version-specific.

Socket client for communicating with Interactive Brokers.

Public constants

Name	Value
UNSET_DOUBLE	1.7976931348623157e+308
UNSET_INTEGER	2147483647

Client

Client(wrapper)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client

Advanced or protocol-level surface classified separately from application utilities.

Replacement for ibapi.client.EClient that uses asyncio.

The client is fully asynchronous and has its own event-driven networking code that replaces the networking code of the standard EClient. It also replaces the infinite loop of EClient.run() with the asyncio event loop. It can be used as a drop-in replacement for the standard EClient as provided by IBAPI.

Compared to the standard EClient this client has the following additional features:

• client.connect() will block until the client is ready to serve requests; It is not necessary to wait for nextValidId to start requests as the client has already done that. The reqId is directly available with :py.getReqId().

• client.connectAsync() is a coroutine for connecting asynchronously.

• When blocking, client.connect() can be made to time out with the timeout parameter (default 2 seconds).

• Optional wrapper.priceSizeTick(reqId, tickType, price, size) that combines price and size instead of the two wrapper methods priceTick and sizeTick.

• Automatic request throttling.

• Optional wrapper.tcpDataArrived() method; If the wrapper has this method it is invoked directly after a network packet has arrived. A possible use is to timestamp all data in the packet with the exact same time.

• Optional wrapper.tcpDataProcessed() method; If the wrapper has this method it is invoked after the network packet's data has been handled. A possible use is to write or evaluate the newly arrived data in one batch instead of item by item.

Parameters: MaxRequests (int): Throttle the number of requests to MaxRequests per RequestsInterval seconds. Set to 0 to disable throttling. RequestsInterval (float): Time interval (in seconds) for request throttling. MinClientVersion (int): Client protocol version. MaxClientVersion (int): Client protocol version.

Events:

• apiStart ()
• apiEnd ()
• apiError (errorMsg: str)
• throttleStart ()
• throttleEnd ()

calculateImpliedVolatility

calculateImpliedVolatility(self, reqId, contract, optionPrice, underPrice, implVolOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.calculateImpliedVolatility

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.calculateImpliedVolatilityAsync
• Protocol mapping: EClient.calculateImpliedVolatility
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

calculateOptionPrice

calculateOptionPrice(self, reqId, contract, volatility, underPrice, optPrcOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.calculateOptionPrice

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.calculateOptionPriceAsync
• Protocol mapping: EClient.calculateOptionPrice
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelAccountSummary

cancelAccountSummary(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelAccountSummary

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.cancelAccountSummary
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelAccountUpdatesMulti

cancelAccountUpdatesMulti(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelAccountUpdatesMulti

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.cancelAccountUpdatesMulti
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelCalculateImpliedVolatility

cancelCalculateImpliedVolatility(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelCalculateImpliedVolatility

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.calculateImpliedVolatilityAsync
• Protocol mapping: EClient.cancelCalculateImpliedVolatility
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelCalculateOptionPrice

cancelCalculateOptionPrice(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelCalculateOptionPrice

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.calculateOptionPriceAsync
• Protocol mapping: EClient.cancelCalculateOptionPrice
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelFundamentalData

cancelFundamentalData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelFundamentalData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.cancelFundamentalData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelHeadTimeStamp

cancelHeadTimeStamp(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelHeadTimeStamp

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHeadTimeStampAsync
• Protocol mapping: EClient.cancelHeadTimeStamp
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelHistogramData

cancelHistogramData(self, tickerId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelHistogramData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.cancelHistogramData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelHistoricalData

cancelHistoricalData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelHistoricalData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelHistoricalData
• Called by: IB.reqHistoricalDataAsync
• Protocol mapping: EClient.cancelHistoricalData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelMktData

cancelMktData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelMktData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelMktData
• Protocol mapping: EClient.cancelMktData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelMktDepth

cancelMktDepth(self, reqId, isSmartDepth)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelMktDepth

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelMktDepth
• Protocol mapping: EClient.cancelMktDepth
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelNewsBulletins

cancelNewsBulletins(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelNewsBulletins

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelNewsBulletins
• Protocol mapping: EClient.cancelNewsBulletins
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelOrder

cancelOrder(self, orderId, manualCancelOrderTime='')

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelOrder

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelOrder
• Protocol mapping: EClient.cancelOrder
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelPnL

cancelPnL(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelPnL

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelPnL
• Protocol mapping: EClient.cancelPnL
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelPnLSingle

cancelPnLSingle(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelPnLSingle

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelPnLSingle
• Protocol mapping: EClient.cancelPnLSingle
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelPositions

cancelPositions(self)

Completeness: fully-documented · Canonical ID: ib_async.client.Client.cancelPositions

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Protocol mapping: EClient.cancelPositions
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelPositionsMulti

cancelPositionsMulti(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelPositionsMulti

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.cancelPositionsMulti
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelRealTimeBars

cancelRealTimeBars(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelRealTimeBars

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelRealTimeBars
• Protocol mapping: EClient.cancelRealTimeBars
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelScannerSubscription

cancelScannerSubscription(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelScannerSubscription

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelScannerSubscription
• Called by: IB.reqScannerDataAsync
• Protocol mapping: EClient.cancelScannerSubscription
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelTickByTickData

cancelTickByTickData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelTickByTickData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelTickByTickData
• Protocol mapping: EClient.cancelTickByTickData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelWshEventData

cancelWshEventData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelWshEventData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelWshEventData
• Protocol mapping: EClient.cancelWshEventData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

cancelWshMetaData

cancelWshMetaData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.cancelWshMetaData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.cancelWshMetaData
• Protocol mapping: EClient.cancelWshMetaData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

connect

connect(self, host: str, port: int, clientId: int, timeout: float | None = 2.0)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.connect

Advanced or protocol-level surface classified separately from application utilities.

Connect to a running TWS or IB gateway application.

Args: host: Host name or IP address. port: Port number. clientId: ID number to use for this client; must be unique per connection. timeout: If establishing the connection takes longer than timeout seconds then the asyncio.TimeoutError exception is raised. Set to 0 to disable timeout.

connectAsync

connectAsync(self, host, port, clientId, timeout=2.0)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.connectAsync

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.connectAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

connectionStats

connectionStats(self) -> ib_async.objects.ConnectionStats

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.connectionStats

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.disconnect

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Get statistics about the connection.

disconnect

disconnect(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.disconnect

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.disconnect

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Disconnect from IB connection.

exerciseOptions

exerciseOptions(self, reqId, contract, exerciseAction, exerciseQuantity, account, override)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.exerciseOptions

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.exerciseOptions
• Protocol mapping: EClient.exerciseOptions
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

getAccounts

getAccounts(self) -> list[str]

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.getAccounts

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.connectAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Get the list of account names that are under management.

getReqId

getReqId(self) -> int

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.getReqId

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.bracketOrder
• Called by: IB.calculateImpliedVolatilityAsync
• Called by: IB.calculateOptionPriceAsync
• Called by: IB.exerciseOptions
• Called by: IB.placeOrder
• Called by: IB.replaceFA
• Called by: IB.reqAccountSummaryAsync
• Called by: IB.reqAccountUpdatesMultiAsync
• Called by: IB.reqContractDetailsAsync
• Called by: IB.reqExecutionsAsync
• Called by: IB.reqFundamentalDataAsync
• Called by: IB.reqHeadTimeStampAsync
• Called by: IB.reqHistogramDataAsync
• Called by: IB.reqHistoricalDataAsync
• Called by: IB.reqHistoricalNewsAsync
• Called by: IB.reqHistoricalScheduleAsync
• Called by: IB.reqHistoricalTicksAsync
• Called by: IB.reqMatchingSymbolsAsync
• Called by: IB.reqMktData
• Called by: IB.reqMktDepth
• Called by: IB.reqNewsArticleAsync
• Called by: IB.reqPnL
• Called by: IB.reqPnLSingle
• Called by: IB.reqRealTimeBars
• Called by: IB.reqScannerSubscription
• Called by: IB.reqSecDefOptParamsAsync
• Called by: IB.reqSmartComponentsAsync
• Called by: IB.reqTickByTickData
• Called by: IB.reqTickersAsync
• Called by: IB.reqUserInfoAsync
• Called by: IB.reqWshEventData
• Called by: IB.reqWshMetaData
• Called by: IB.whatIfOrderAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Get new request ID.

isConnected

isConnected(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.isConnected

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.disconnect

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

isReady

isReady(self) -> bool

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.isReady

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.connectAsync
• Called by: IB.isConnected

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Is the API connection up and running?

placeOrder

placeOrder(self, orderId, contract, order)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.placeOrder

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.placeOrder
• Called by: IB.whatIfOrderAsync
• Protocol mapping: EClient.placeOrder
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

queryDisplayGroups

queryDisplayGroups(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.queryDisplayGroups

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.queryDisplayGroups
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

replaceFA

replaceFA(self, reqId, faData, cxml)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.replaceFA

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.replaceFA
• Protocol mapping: EClient.replaceFA
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqAccountSummary

reqAccountSummary(self, reqId, groupName, tags)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqAccountSummary

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqAccountSummaryAsync
• Protocol mapping: EClient.reqAccountSummary
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqAccountUpdates

reqAccountUpdates(self, subscribe, acctCode)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqAccountUpdates

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqAccountUpdatesAsync
• Protocol mapping: EClient.reqAccountUpdates
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqAccountUpdatesMulti

reqAccountUpdatesMulti(self, reqId, account, modelCode, ledgerAndNLV)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqAccountUpdatesMulti

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqAccountUpdatesMultiAsync
• Protocol mapping: EClient.reqAccountUpdatesMulti
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqAllOpenOrders

reqAllOpenOrders(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqAllOpenOrders

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqAllOpenOrdersAsync
• Protocol mapping: EClient.reqAllOpenOrders
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqAutoOpenOrders

reqAutoOpenOrders(self, bAutoBind)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqAutoOpenOrders

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqAutoOpenOrders
• Protocol mapping: EClient.reqAutoOpenOrders
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqCompletedOrders

reqCompletedOrders(self, apiOnly)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqCompletedOrders

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqCompletedOrdersAsync
• Protocol mapping: EClient.reqCompletedOrders
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqContractDetails

reqContractDetails(self, reqId, contract)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqContractDetails

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqContractDetailsAsync
• Protocol mapping: EClient.reqContractDetails
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqCurrentTime

reqCurrentTime(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqCurrentTime

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqCurrentTimeAsync
• Protocol mapping: EClient.reqCurrentTime
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqExecutions

reqExecutions(self, reqId, execFilter)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqExecutions

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqExecutionsAsync
• Protocol mapping: EClient.reqExecutions
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqFamilyCodes

reqFamilyCodes(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqFamilyCodes

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.reqFamilyCodes
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqFundamentalData

reqFundamentalData(self, reqId, contract, reportType, fundamentalDataOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqFundamentalData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqFundamentalDataAsync
• Protocol mapping: EClient.reqFundamentalData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqGlobalCancel

reqGlobalCancel(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqGlobalCancel

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqGlobalCancel
• Protocol mapping: EClient.reqGlobalCancel
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqHeadTimeStamp

reqHeadTimeStamp(self, reqId, contract, whatToShow, useRTH, formatDate)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqHeadTimeStamp

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHeadTimeStampAsync
• Protocol mapping: EClient.reqHeadTimeStamp
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqHistogramData

reqHistogramData(self, tickerId, contract, useRTH, timePeriod)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqHistogramData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHistogramDataAsync
• Protocol mapping: EClient.reqHistogramData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqHistoricalData

reqHistoricalData(self, reqId, contract, endDateTime, durationStr, barSizeSetting, whatToShow, useRTH, formatDate, keepUpToDate, chartOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqHistoricalData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHistoricalDataAsync
• Called by: IB.reqHistoricalScheduleAsync
• Protocol mapping: EClient.reqHistoricalData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqHistoricalNews

reqHistoricalNews(self, reqId, conId, providerCodes, startDateTime, endDateTime, totalResults, historicalNewsOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqHistoricalNews

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHistoricalNewsAsync
• Protocol mapping: EClient.reqHistoricalNews
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqHistoricalTicks

reqHistoricalTicks(self, reqId, contract, startDateTime, endDateTime, numberOfTicks, whatToShow, useRth, ignoreSize, miscOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqHistoricalTicks

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqHistoricalTicksAsync
• Protocol mapping: EClient.reqHistoricalTicks
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqIds

reqIds(self, numIds)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqIds

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.reqIds
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqManagedAccts

reqManagedAccts(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqManagedAccts

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.reqManagedAccts
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMarketDataType

reqMarketDataType(self, marketDataType)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMarketDataType

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMarketDataType
• Protocol mapping: EClient.reqMarketDataType
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMarketRule

reqMarketRule(self, marketRuleId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMarketRule

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMarketRuleAsync
• Protocol mapping: EClient.reqMarketRule
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMatchingSymbols

reqMatchingSymbols(self, reqId, pattern)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMatchingSymbols

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMatchingSymbolsAsync
• Protocol mapping: EClient.reqMatchingSymbols
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMktData

reqMktData(self, reqId, contract, genericTickList, snapshot, regulatorySnapshot, mktDataOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMktData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMktData
• Called by: IB.reqTickersAsync
• Protocol mapping: EClient.reqMktData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMktDepth

reqMktDepth(self, reqId, contract, numRows, isSmartDepth, mktDepthOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMktDepth

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMktDepth
• Protocol mapping: EClient.reqMktDepth
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqMktDepthExchanges

reqMktDepthExchanges(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqMktDepthExchanges

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqMktDepthExchangesAsync
• Protocol mapping: EClient.reqMktDepthExchanges
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqNewsArticle

reqNewsArticle(self, reqId, providerCode, articleId, newsArticleOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqNewsArticle

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqNewsArticleAsync
• Protocol mapping: EClient.reqNewsArticle
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqNewsBulletins

reqNewsBulletins(self, allMsgs)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqNewsBulletins

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqNewsBulletins
• Protocol mapping: EClient.reqNewsBulletins
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqNewsProviders

reqNewsProviders(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqNewsProviders

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqNewsProvidersAsync
• Protocol mapping: EClient.reqNewsProviders
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqOpenOrders

reqOpenOrders(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqOpenOrders

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqOpenOrdersAsync
• Protocol mapping: EClient.reqOpenOrders
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqPnL

reqPnL(self, reqId, account, modelCode)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqPnL

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqPnL
• Protocol mapping: EClient.reqPnL
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqPnLSingle

reqPnLSingle(self, reqId, account, modelCode, conid)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqPnLSingle

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqPnLSingle
• Protocol mapping: EClient.reqPnLSingle
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqPositions

reqPositions(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqPositions

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqPositionsAsync
• Protocol mapping: EClient.reqPositions
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqPositionsMulti

reqPositionsMulti(self, reqId, account, modelCode)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqPositionsMulti

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.reqPositionsMulti
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqRealTimeBars

reqRealTimeBars(self, reqId, contract, barSize, whatToShow, useRTH, realTimeBarsOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqRealTimeBars

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqRealTimeBars
• Protocol mapping: EClient.reqRealTimeBars
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqScannerParameters

reqScannerParameters(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqScannerParameters

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqScannerParametersAsync
• Protocol mapping: EClient.reqScannerParameters
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqScannerSubscription

reqScannerSubscription(self, reqId, subscription, scannerSubscriptionOptions, scannerSubscriptionFilterOptions)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqScannerSubscription

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqScannerSubscription
• Protocol mapping: EClient.reqScannerSubscription
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqSecDefOptParams

reqSecDefOptParams(self, reqId, underlyingSymbol, futFopExchange, underlyingSecType, underlyingConId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqSecDefOptParams

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqSecDefOptParamsAsync
• Protocol mapping: EClient.reqSecDefOptParams
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqSmartComponents

reqSmartComponents(self, reqId, bboExchange)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqSmartComponents

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqSmartComponentsAsync
• Protocol mapping: EClient.reqSmartComponents
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqSoftDollarTiers

reqSoftDollarTiers(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqSoftDollarTiers

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.reqSoftDollarTiers
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqTickByTickData

reqTickByTickData(self, reqId, contract, tickType, numberOfTicks, ignoreSize)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqTickByTickData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqTickByTickData
• Protocol mapping: EClient.reqTickByTickData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqUserInfo

reqUserInfo(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqUserInfo

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqUserInfoAsync
• Protocol mapping: EClient.reqUserInfo
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqWshEventData

reqWshEventData(self, reqId, data: ib_async.objects.WshEventData)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqWshEventData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqWshEventData
• Protocol mapping: EClient.reqWshEventData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reqWshMetaData

reqWshMetaData(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reqWshMetaData

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.reqWshMetaData
• Protocol mapping: EClient.reqWshMetaData
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

requestFA

requestFA(self, faData)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.requestFA

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.requestFAAsync
• Protocol mapping: EClient.requestFA
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

reset

reset(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.reset

Advanced or protocol-level surface classified separately from application utilities.

No library docstring is provided; consult the signature, type fields, and operational guides.

run

run(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.run

Advanced or protocol-level surface classified separately from application utilities.

No library docstring is provided; consult the signature, type fields, and operational guides.

send

send(self, *fields, makeEmpty=True)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.send

Advanced or protocol-level surface classified separately from application utilities.

Serialize and send the given fields using the IB socket protocol.

if 'makeEmpty' is True (default), then the IBKR values representing "no value" become the empty string.

sendMsg

sendMsg(self, msg: str)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.sendMsg

Advanced or protocol-level surface classified separately from application utilities.

No library docstring is provided; consult the signature, type fields, and operational guides.

serverVersion

serverVersion(self) -> int

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.serverVersion

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Called by: IB.connectAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

setConnectOptions

setConnectOptions(self, connectOptions: str)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.setConnectOptions

Advanced or protocol-level surface classified separately from application utilities.

Set additional connect options.

Args: connectOptions: Use "+PACEAPI" to use request-pacing built into TWS/gateway 974+ (obsolete).

setServerLogLevel

setServerLogLevel(self, logLevel)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.setServerLogLevel

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.setServerLogLevel
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

startApi

startApi(self)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.startApi

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.startApi
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

subscribeToGroupEvents

subscribeToGroupEvents(self, reqId, groupId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.subscribeToGroupEvents

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.subscribeToGroupEvents
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

unsubscribeFromGroupEvents

unsubscribeFromGroupEvents(self, reqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.unsubscribeFromGroupEvents

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.unsubscribeFromGroupEvents
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

updateDisplayGroup

updateDisplayGroup(self, reqId, contractInfo)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.updateDisplayGroup

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.updateDisplayGroup
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

updateReqId

updateReqId(self, minReqId)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.updateReqId

Advanced or protocol-level surface classified separately from application utilities.

Update the next reqId to be at least minReqId.

verifyAndAuthMessage

verifyAndAuthMessage(self, apiData, xyzResponse)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.verifyAndAuthMessage

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.verifyAndAuthMessage
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

verifyAndAuthRequest

verifyAndAuthRequest(self, apiName, apiVersion, opaqueIsvKey)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.verifyAndAuthRequest

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.verifyAndAuthRequest
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

verifyMessage

verifyMessage(self, apiData)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.verifyMessage

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.verifyMessage
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.

verifyRequest

verifyRequest(self, apiName, apiVersion)

Completeness: advanced-low-level · Canonical ID: ib_async.client.Client.verifyRequest

Advanced or protocol-level surface classified separately from application utilities.

Related API navigation

• Protocol mapping: EClient.verifyRequest
• Error reference: TWS message codes (applicability is request-dependent).

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

No library docstring is provided; consult the signature, type fields, and operational guides.