IB.reqScannerSubscription

Back to ib_async.ib.IB

reqScannerSubscription(self, subscription: ib_async.objects.ScannerSubscription, scannerSubscriptionOptions: list[ib_async.contract.TagValue] = [], scannerSubscriptionFilterOptions: list[ib_async.contract.TagValue] = []) -> ib_async.objects.ScanDataList

Completeness: signature-only · Canonical ID: ib_async.ib.IB.reqScannerSubscription

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Called by: IB.reqScannerDataAsync
• Calls: Client.getReqId
• Calls: Client.reqScannerSubscription
• Cancel operation: IB.cancelScannerSubscription
• Protocol mapping: EClient.reqScannerSubscription
• Response callback: EWrapper.scannerData
• Returns: ScanDataList
• 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)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Subscribe to market scan data.

https://interactivebrokers.github.io/tws-api/market_scanners.html

Args: subscription: What to scan for. scannerSubscriptionOptions: Unknown. scannerSubscriptionFilterOptions: Unknown.