parkpapapa / ib_insync

Python sync/async framework for Interactive Brokers API

Introduction

The ib_insync package is build on top of the Python API from Interactive Brokers. The objective is to make it as easy as possible to use the API to its fullest extent.

The main features are:

• An IB component that automatically keeps in sync;
• An easy to use linear style of programming (no more callbacks);
• A fully asynchonous framework based on asyncio for advanced users;
• Interactive operation with live data in Jupyter notebooks.

Installation

pip3 install -U ib_insync

Requirements:

• Python version 3.6 or higher;
• The Interactive Brokers Python API version 9.73.03 or higher;
• A running TWS or IB gateway application (version 967 or higher). Make sure the API port is enabled and 'Download open orders on connection' is checked.

To install packages needed for the examples and notebooks:

pip3 install -U jupyter numpy pandas

Example

This is a complete script to download historical data:

from ib_insync import *

ib = IB()
ib.connect('127.0.0.1', 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']])

Output:

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

Be sure to take a look at the example notebooks too.

Documentation

API docs

Discussion

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

Disclaimer

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

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

Changelog

Version 0.8.7

• BarDataList now used with reqHistoricalData; it also stores the request parameters
• updated the typing annotations
• added barUpdate event to IB
• bar- and tick-data notebooks updated to use callbacks for realtime data

Version 0.8.6

• ticker.marketPrice adjusted to ignore price of -1
• ticker.avVolume handling fixed

Version 0.8.5

• realtimeBar wrapper fix
• context manager for IB and IB.connect()

Version 0.8.4

• compatibility with upcoming ibapi changes
• added error event to IB
• notebooks updated to use loopUntil
• small fixes and performance improvements

Version 0.8.3

• new IB.reqHistoricalTicks API method
• new IB.loopUntil method
• fixed issues #4, #6, #7

Version 0.8.2

• fixed swapped ticker.putOpenInterest vs ticker.callOpenInterest

Version 0.8.1

• fixed wrapper.tickSize regression

Version 0.8.0

• support for realtime bars and keepUpToDate for historical bars
• added option greeks to Ticker
• new IB.waitUntil and IB.timeRange scheduling methods
• notebooks no longer depend on PyQt5 for live updates
• notebooks can be run in one go ('run all')
• tick handling bypasses ibapi decoder for more efficiency

Version 0.7.3

• IB.whatIfOrder() added
• Added detection and warning about common setup problems

Version 0.7.2

• Removed import from ipykernel

Version 0.7.1

• Removed dependencies for installing via pip

Version 0.7.0

• added lots of request methods
• order book (DOM) added
• notebooks updated

Version 0.6.1

• Added UTC timezone to some timestamps
• Fixed issue #1

Version 0.6.0

• Initial release

Good luck and enjoy,

author

Ewald de Wit <[email protected]>