Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python sync/async framework for Interactive Brokers API

Project description

Build Join the user group PyPi Conda Number of downloads Documentation


The goal of the IB-insync library is to make working with the Trader Workstation API from Interactive Brokers as easy as possible.

The main features are:

  • An easy to use linear style of programming;
  • An IB component that automatically keeps in sync with the TWS or IB Gateway application;
  • A fully asynchonous framework based on asyncio and eventkit for advanced users;
  • Interactive operation with live data in Jupyter notebooks.

Be sure to take a look at the notebooks, the recipes and the API docs.


pip3 install -U ib_insync

On some systems pip should be used instead of pip3.

To install for a single user, add --user to the command.


  • Python 3.6 or higher;
  • A running TWS or IB Gateway application (version 972 or higher). Make sure the API port is enabled and ‘Download open orders on connection’ is checked.

The ibapi package from IB is not needed.


This is a complete script to download historical data:

from ib_insync import *
# util.startLoop()  # uncomment this line when in a notebook

ib = IB()
ib.connect('', 7497, clientId=1)

contract = Forex('EURUSD')
bars = ib.reqHistoricalData(contract, endDateTime='', durationStr='30 D',
        barSizeSetting='1 hour', whatToShow='MIDPOINT', useRTH=True)

# convert to pandas dataframe:
df = util.df(bars)
print(df[['date', 'open', 'high', 'low', 'close']])


                   date      open      high       low     close
0   2017-08-13 23:15:00  1.182850  1.183100  1.182100  1.182400
1   2017-08-14 00:00:00  1.182400  1.182450  1.181875  1.182175
2   2017-08-14 01:00:00  1.182175  1.182675  1.181900  1.182525
719 2017-09-22 22:00:00  1.194425  1.195425  1.194225  1.195050


The complete API documentation.



The insync user group is the place to discuss IB-insync and anything related to it.

Consultancy & Development

IB-insync offers an easy entry into building automated trading systems for both individual traders and fintech companies. However, to get the most out of it is not a trivial matter and is beyond the reach of most developers.

If you need expert help, you can contact me. This can be for a small project, such as fixing something in your own code, or it can be creating an entire new trading infrastructure. Please provide enough details so that I can assess both the feasibility and the scope. Many folks worry about having to provide their ‘secret sauce’, but that is never necessary (although you’re perfectly welcome to send that as well!)


The software is provided on the conditions of the simplified BSD license.

This project is not affiliated with Interactive Brokers Group, Inc.’s.

Good luck and enjoy,

author:Ewald de Wit <>

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ib-insync, version 0.9.58
Filename, size File type Python version Upload date Hashes
Filename, size ib_insync-0.9.58-py3-none-any.whl (68.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ib_insync-0.9.58.tar.gz (62.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page