How To Obtain Contract Details From The Interactive Brokers Api?

Following the Interactive Brokers documentation I am trying to obtain the contract details using the below code: from ibapi.client import EClient from ibapi.wrapper import EWrappe

Solution 1:

from ibapi.client import EClient
from ibapi.wrapper import EWrapper


classMyWrapper(EWrapper):

    defnextValidId(self, orderId:int):
        print("setting nextValidOrderId: %d", orderId)
        self.nextValidOrderId = orderId
        # start program here or use threading
        app.reqContractDetails(4444, contract)

    defcontractDetails(self, reqId, contractDetails):
        print(reqId, contractDetails.contract)# my version doesnt use summarydefcontractDetailsEnd(self, reqId):
        print("ContractDetailsEnd. ", reqId)
        # this is the logical end of your program
        app.disconnect() # delete if threading and you want to stay connecteddeferror(self, reqId, errorCode, errorString):
        print("Error. Id: " , reqId, " Code: " , errorCode , " Msg: " , errorString)


wrapper = MyWrapper()
app = EClient(wrapper)
app.connect("127.0.0.1", 7497, clientId=123)
print("serverVersion:%s connectionTime:%s" % (app.serverVersion(), app.twsConnectionTime()))

from ibapi.contract import Contract
contract = Contract()
contract.symbol = "XAUUSD"
contract.secType = "CMDTY"
contract.exchange = "SMART"
contract.currency = "USD"

app.run() # delete this line if threading# def runMe():#     app.run()# import threading# thread = threading.Thread(target = runMe)# thread.start()# input('enter to disconnect')# app.disconnect()

You are asking for data before you start the message reader. Maybe you get the data before it starts.

IB recommends starting the program after you receive nextValidId so you know everything is running properly. Since the python API blocks in a message read loop you need to implement threading or structure your program to run asynchronously.

I've shown how to do it so it will just run with no user input and it is event driven, or asynchronous. This means the program waits until it is supposed to do something and then it does it.

I've including the threading option, just change the comments.

ContractDetails.summary has been changed to contract. I'm not sure it ever was summary in python, don't know where you got that from.

Solution 2:

Using ib_insync package with Python 3, you can also do the following if you want to get the details for a list of contracts all stored in a df:

from ib_insync import *
import pandas as pd


defadd_contract_details(ib_client, ib_contract, df):
    list_of_contract_details = ib_client.reqContractDetails(contract=ib_contract)
    if list_of_contract_details:
        print(
            f"Found {len(list_of_contract_details)} contract{'s'iflen(list_of_contract_details) > 1else''} for {ib_contract.symbol}: "
        )
        for contract_details in list_of_contract_details:
            data = {}
            for k, v in contract_details.contract.__dict__.items():
                data[k] = v
            for k, v in contract_details.__dict__.items():
                if k != "contract":
                    data[k] = v
            df = pd.DataFrame([data]) if df isNoneelse df.append(pd.DataFrame([data]))
    else:
        print(f"No details found for contract {ib_contract.symbol}.")
    return df



ib = IB()
ib.connect(host="127.0.0.1", port=7497, clientId=1)
btc_fut_cont_contract = ContFuture("BRR", "CMECRYPTO")
ib.qualifyContracts(btc_fut_cont_contract)
fx_contract_usdjpy = Forex('USDJPY')
ib.qualifyContracts(fx_contract_usdjpy)

df_contract_details = Nonefor c in [btc_fut_cont_contract, fx_contract_usdjpy]:
    df_contract_details = add_contract_details(ib, c, df_contract_details)
print(df_contract_details)