Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Get IB historical data native python API updated for bar class
# Gist example of IB wrapper ...
# Download API from
# Install python API code /IBJts/source/pythonclient $ python3 install
# Note: The test cases, and the documentation refer to a python package called IBApi,
# but the actual package is called ibapi. Go figure.
# Get the latest version of the gateway:
# (for unix: windows and mac users please find your own version)
# Run the gateway
# user: edemo
# pwd: demo123
from ibapi.wrapper import EWrapper
from ibapi.client import EClient
from ibapi.contract import Contract as IBcontract
from threading import Thread
import queue
import datetime
## marker for when queue is finished
FINISHED = object()
STARTED = object()
TIME_OUT = object()
class finishableQueue(object):
def __init__(self, queue_to_finish):
self._queue = queue_to_finish
self.status = STARTED
def get(self, timeout):
Returns a list of queue elements once timeout is finished, or a FINISHED flag is received in the queue
:param timeout: how long to wait before giving up
:return: list of queue elements
while not finished:
current_element = self._queue.get(timeout=timeout)
if current_element is FINISHED:
finished = True
self.status = FINISHED
## keep going and try and get more data
except queue.Empty:
## If we hit a time out it's most probable we're not getting a finished element any time soon
## give up and return what we have
finished = True
self.status = TIME_OUT
return contents_of_queue
def timed_out(self):
return self.status is TIME_OUT
class TestWrapper(EWrapper):
The wrapper deals with the action coming back from the IB gateway or TWS instance
We override methods in EWrapper that will get called when this action happens, like currentTime
Extra methods are added as we need to store the results in this object
def __init__(self):
self._my_contract_details = {}
self._my_historic_data_dict = {}
## error handling code
def init_error(self):
self._my_errors = error_queue
def get_error(self, timeout=5):
if self.is_error():
return self._my_errors.get(timeout=timeout)
except queue.Empty:
return None
return None
def is_error(self):
an_error_if=not self._my_errors.empty()
return an_error_if
def error(self, id, errorCode, errorString):
## Overriden method
errormsg = "IB error id %d errorcode %d string %s" % (id, errorCode, errorString)
## get contract details code
def init_contractdetails(self, reqId):
contract_details_queue = self._my_contract_details[reqId] = queue.Queue()
return contract_details_queue
def contractDetails(self, reqId, contractDetails):
## overridden method
if reqId not in self._my_contract_details.keys():
def contractDetailsEnd(self, reqId):
## overriden method
if reqId not in self._my_contract_details.keys():
## Historic data code
def init_historicprices(self, tickerid):
historic_data_queue = self._my_historic_data_dict[tickerid] = queue.Queue()
return historic_data_queue
def historicalData(self, tickerid , bar):
## Overriden method
## Note I'm choosing to ignore barCount, WAP and hasGaps but you could use them if you like
bardata=(,, bar.high, bar.low, bar.close, bar.volume)
## Add on to the current data
if tickerid not in historic_data_dict.keys():
def historicalDataEnd(self, tickerid, start:str, end:str):
## overriden method
if tickerid not in self._my_historic_data_dict.keys():
class TestClient(EClient):
The client method
We don't override native methods, but instead call them from our own wrappers
def __init__(self, wrapper):
## Set up with a wrapper inside
EClient.__init__(self, wrapper)
def resolve_ib_contract(self, ibcontract, reqId=DEFAULT_GET_CONTRACT_ID):
From a partially formed contract, returns a fully fledged version
:returns fully resolved IB contract
## Make a place to store the data we're going to return
contract_details_queue = finishableQueue(self.init_contractdetails(reqId))
print("Getting full contract details from the server... ")
self.reqContractDetails(reqId, ibcontract)
## Run until we get a valid contract(s) or get bored waiting
new_contract_details = contract_details_queue.get(timeout = MAX_WAIT_SECONDS)
while self.wrapper.is_error():
if contract_details_queue.timed_out():
print("Exceeded maximum wait for wrapper to confirm finished - seems to be normal behaviour")
if len(new_contract_details)==0:
print("Failed to get additional contract details: returning unresolved contract")
return ibcontract
if len(new_contract_details)>1:
print("got multiple contracts using first one")
return resolved_ibcontract
def get_IB_historical_data(self, ibcontract, durationStr="1 Y", barSizeSetting="1 day",
Returns historical prices for a contract, up to today
ibcontract is a Contract
:returns list of prices in 4 tuples: Open high low close volume
## Make a place to store the data we're going to return
historic_data_queue = finishableQueue(self.init_historicprices(tickerid))
# Request some historical data. Native method in EClient
tickerid, # tickerId,
ibcontract, # contract,"%Y%m%d %H:%M:%S %Z"), # endDateTime,
durationStr, # durationStr,
barSizeSetting, # barSizeSetting,
"TRADES", # whatToShow,
1, # useRTH,
1, # formatDate
False, # KeepUpToDate <<==== added for api 9.73.2
[] ## chartoptions not used
## Wait until we get a completed data, an error, or get bored waiting
print("Getting historical data from the server... could take %d seconds to complete " % MAX_WAIT_SECONDS)
historic_data = historic_data_queue.get(timeout = MAX_WAIT_SECONDS)
while self.wrapper.is_error():
if historic_data_queue.timed_out():
print("Exceeded maximum wait for wrapper to confirm finished - seems to be normal behaviour")
return historic_data
class TestApp(TestWrapper, TestClient):
def __init__(self, ipaddress, portid, clientid):
TestClient.__init__(self, wrapper=self)
self.connect(ipaddress, portid, clientid)
thread = Thread(target =
setattr(self, "_thread", thread)
#if __name__ == '__main__':
app = TestApp("", 4001, 1)
ibcontract = IBcontract()
ibcontract.secType = "FUT"
historic_data = app.get_IB_historical_data(resolved_ibcontract)
Copy link

lawofearth commented Aug 23, 2017

Hi again Rob, I came from stackoverflow.
I have a question about your coding grammar.
what is self._my_name[reqId].put(FINISHED) mean?
I don't understand it but I think this is the tool you use to flag terminate.

Another is @iswrapper that your code has none of it what is it for?

I am trying to integrate your code with mine, hope will work soon!

Thanks again :)

Copy link

nateGeorge commented Oct 24, 2017

In TestWrapper() __init__ you forgot:

self._my_errors = queue.Queue()

Copy link

wuichen commented Jul 8, 2018

for future reference, according to the update from this link , The field 'summary' has been renamed 'contract' in the Python

Copy link

nateGeorge commented Jul 11, 2018

@wuichen thanks. This was throwing an error:

AttributeError: 'ContractDetails' object has no attribute 'summary'

Copy link

wzeng168 commented Aug 12, 2018

change 'summary' to 'contract

Copy link

JigneshGor commented Aug 22, 2018

Thank you for sharing the code and article. It was really helpful.

Copy link

sandhusukhdeep commented Aug 22, 2021

This is awesome, you are very kind and thank you for sharing the article as well as code!

Copy link

robcarver17 commented Sep 14, 2022

FINISHED appears outside any function so it's a global variable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment