IBKR Python API – Contracts Sample Code

Articles From: Interactive Brokers
Website: Interactive Brokers


Start building trading algos in Python with IBKR API resources.

First, download the API installer from GitHub and the latest version of Trader Workstation. 

Next, practice writing Python functions for order types. Let’s review this code for sample European contract specifications from the IBKR API GitHub Guide.

@staticmethod 
def Index():
        #! [indcontract]
        contract = Contract()
        contract.symbol = "DAX"
        contract.secType = "IND"
        contract.currency = "EUR"
        contract.exchange = "DTB"
        #! [indcontract]
        return contract
    @staticmethod
    def EuropeanStock():
        contract = Contract()
        contract.symbol = "SIE"
        contract.secType = "STK"
        contract.currency = "EUR"
        contract.exchange = "SMART"
        return contract

For additional order type function arguments, review the sample syntax for Market, Limit, Stop and Stop Loss orders as instructed in the GitHub OrderSamples.py file. Remember that the Python samples get installed in the samples/Python/Testbed directory. For more API articles, see our news section.

This Python code is subject to the terms and conditions of the IBKR API Non-Commercial License or the IBKR API Commercial License, as applicable.

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, its affiliates, or its employees.

Disclosure: Displaying Symbols on Video

Any stock, options or futures symbols displayed are for illustrative purposes only and are not intended to portray recommendations.

Disclosure: Order Types / TWS

The order types available through Interactive Brokers LLC’s Trader Workstation are designed to help you limit your loss and/or lock in a profit. Market conditions and other factors may affect execution. In general, orders guarantee a fill or guarantee a price, but not both. In extreme market conditions, an order may either be executed at a different price than anticipated or may not be filled in the marketplace.