IB.reqMktDepth
reqMktDepth(self, contract: ib_async.contract.Contract, numRows: int = 5, isSmartDepth: bool = False, mktDepthOptions=None) -> ib_async.ticker.Ticker
Completeness: signature-only · Canonical ID: ib_async.ib.IB.reqMktDepth
Runtime signature is published; semantic enrichment remains outstanding.
Related API navigation
- Calls:
Client.getReqId - Calls:
Client.reqMktDepth - Cancel operation:
IB.cancelMktDepth - Protocol mapping:
EClient.reqMktDepth - Response callback:
EWrapper.updateMktDepth - Response callback:
EWrapper.updateMktDepthL2 - Returns:
Ticker - Error reference: TWS message codes (applicability is request-dependent).
Sources and provenance
- ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z) - ib-async-repository-2-1-0 (
library-source; retrieved2026-07-15T03:42:42Z)
Subscribe to market depth data (a.k.a. DOM, L2 or order book).
https://interactivebrokers.github.io/tws-api/market_depth.html
Args: contract: Contract of interest. numRows: Number of depth level on each side of the order book (5 max). isSmartDepth: Consolidate the order book across exchanges. mktDepthOptions: Unknown.
Returns:
The Ticker that holds the market depth in ticker.domBids
and ticker.domAsks and the list of MktDepthData in
ticker.domTicks.