Last active
January 2, 2024 06:02
-
-
Save robcarver17/f50aeebc2ecd084f818706d9f05c1eb4 to your computer and use it in GitHub Desktop.
Get IB historical data native python API updated for bar class
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Gist example of IB wrapper ... | |
# | |
# Download API from http://interactivebrokers.github.io/# | |
# | |
# Install python API code /IBJts/source/pythonclient $ python3 setup.py 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: | |
# https://www.interactivebrokers.com/en/?f=%2Fen%2Fcontrol%2Fsystemstandalone-ibGateway.php%3Fos%3Dunix | |
# (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 | |
DEFAULT_HISTORIC_DATA_ID=50 | |
DEFAULT_GET_CONTRACT_ID=43 | |
## 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 | |
""" | |
contents_of_queue=[] | |
finished=False | |
while not finished: | |
try: | |
current_element = self._queue.get(timeout=timeout) | |
if current_element is FINISHED: | |
finished = True | |
self.status = FINISHED | |
else: | |
contents_of_queue.append(current_element) | |
## 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): | |
error_queue=queue.Queue() | |
self._my_errors = error_queue | |
def get_error(self, timeout=5): | |
if self.is_error(): | |
try: | |
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) | |
self._my_errors.put(errormsg) | |
## 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(): | |
self.init_contractdetails(reqId) | |
self._my_contract_details[reqId].put(contractDetails) | |
def contractDetailsEnd(self, reqId): | |
## overriden method | |
if reqId not in self._my_contract_details.keys(): | |
self.init_contractdetails(reqId) | |
self._my_contract_details[reqId].put(FINISHED) | |
## 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.date, bar.open, bar.high, bar.low, bar.close, bar.volume) | |
historic_data_dict=self._my_historic_data_dict | |
## Add on to the current data | |
if tickerid not in historic_data_dict.keys(): | |
self.init_historicprices(tickerid) | |
historic_data_dict[tickerid].put(bardata) | |
def historicalDataEnd(self, tickerid, start:str, end:str): | |
## overriden method | |
if tickerid not in self._my_historic_data_dict.keys(): | |
self.init_historicprices(tickerid) | |
self._my_historic_data_dict[tickerid].put(FINISHED) | |
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 | |
MAX_WAIT_SECONDS = 10 | |
new_contract_details = contract_details_queue.get(timeout = MAX_WAIT_SECONDS) | |
while self.wrapper.is_error(): | |
print(self.get_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") | |
new_contract_details=new_contract_details[0] | |
resolved_ibcontract=new_contract_details.contract | |
return resolved_ibcontract | |
def get_IB_historical_data(self, ibcontract, durationStr="1 Y", barSizeSetting="1 day", | |
tickerid=DEFAULT_HISTORIC_DATA_ID): | |
""" | |
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 | |
self.reqHistoricalData( | |
tickerid, # tickerId, | |
ibcontract, # contract, | |
datetime.datetime.today().strftime("%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 | |
MAX_WAIT_SECONDS = 10 | |
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(): | |
print(self.get_error()) | |
if historic_data_queue.timed_out(): | |
print("Exceeded maximum wait for wrapper to confirm finished - seems to be normal behaviour") | |
self.cancelHistoricalData(tickerid) | |
return historic_data | |
class TestApp(TestWrapper, TestClient): | |
def __init__(self, ipaddress, portid, clientid): | |
TestWrapper.__init__(self) | |
TestClient.__init__(self, wrapper=self) | |
self.connect(ipaddress, portid, clientid) | |
thread = Thread(target = self.run) | |
thread.start() | |
setattr(self, "_thread", thread) | |
self.init_error() | |
#if __name__ == '__main__': | |
app = TestApp("127.0.0.1", 4001, 1) | |
ibcontract = IBcontract() | |
ibcontract.secType = "FUT" | |
ibcontract.lastTradeDateOrContractMonth="201809" | |
ibcontract.symbol="GE" | |
ibcontract.exchange="GLOBEX" | |
resolved_ibcontract=app.resolve_ib_contract(ibcontract) | |
historic_data = app.get_IB_historical_data(resolved_ibcontract) | |
print(historic_data) | |
app.disconnect() |
for future reference, according to the update from this link https://www.interactivebrokers.com/en/index.php?f=24356 , The field 'summary' has been renamed 'contract' in the Python
@wuichen thanks. This was throwing an error:
AttributeError: 'ContractDetails' object has no attribute 'summary'
change 'summary' to 'contract
Thank you for sharing the code and article. It was really helpful.
This is awesome, you are very kind and thank you for sharing the article as well as code!
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
In
TestWrapper()
__init__
you forgot:self._my_errors = queue.Queue()