Learn how to request a list of market scanners with our API.
- The function
reqScannerParametersretrieves TWS scanners via the API. Generic filters are available but will require Market Data Subscriptions.
- The function
reqScannerSubscriptionretrieves advanced market scanners. This function is important when requesting Complex Orders and Trades Scanner
Our GitHub guide provides practical examples and ready-to-use Python code:
#Hot US stocks by volume
scanSub = ScannerSubscription()
scanSub.instrument = “STK”
scanSub.locationCode = “STK.US.MAJOR”
scanSub.scanCode = “HOT_BY_VOLUME”
Visit the Scanner Example and Parameter pages on GitHub for samples in Java, C++ and C#.
Please note that a maximum of 50 results per scan code is implemented.
For a comprehensive and visual presentation of TWS scanners via the API, be sure to sign up for our Traders’ Academy courses.
Disclosure: Interactive Brokers
The analysis in this material is provided for information only and is not and should not be construed as an offer to sell or the solicitation of an offer to buy any security. To the extent that this material discusses general market activity, industry or sector trends or other broad-based economic or political conditions, it should not be construed as research or investment advice. To the extent that it includes references to specific securities, commodities, currencies, or other instruments, those references do not constitute a recommendation by IBKR to buy, sell or hold such investments. This material does not and is not intended to take into account the particular financial conditions, investment objectives or requirements of individual customers. Before acting on this material, you should consider whether it is suitable for your particular circumstances and, as necessary, seek professional advice.
The views and opinions expressed herein are those of the author and do not necessarily reflect the views of Interactive Brokers LLC, its affiliates, or its employees.
Any trading symbols displayed are for illustrative purposes only and are not intended to portray recommendations.
In accordance with EU regulation: The statements in this document shall not be considered as an objective or independent explanation of the matters. Please note that this document (a) has not been prepared in accordance with legal requirements designed to promote the independence of investment research, and (b) is not subject to any prohibition on dealing ahead of the dissemination or publication of investment research.