
API users can get contract details from the IBKR Reference database via the function IBApi.EClient.reqContractDetails
Among some of the key parameters required to invoke this function are contracts conID, exchange and local (IBKR) symbols, and currency.
In case there are multiple matches for a contract in the IBKR database, users can narrow down the results with the help of the function IBApi::EWrapper::contractDetails
.
Furthermore, as the script might take some time to run, consider narrowing the request down to the list of contract matches.
In addition, quants should consult our GitHub Guide for exceptions and restrictions, such as coding parameters for fixed income returns or USD-denominated contracts: https://interactivebrokers.github.io/tws-api/contract_details.html
Also, be sure to follow our API news channel for additional syntax samples and API updates.
Finally, sign up for Traders’ Academy API courses for comprehensive and visual training in trading via the API.
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.