Skip to main content

Python sync/async framework for Interactive Brokers API

Project description

Build Join the user group PyPi Conda Number of downloads Documentation

Introduction

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.

Installation

pip install ib_insync

For Python 3.6 install the dataclasses package as well (newer Python versions already have it):

pip install dataclasses

Requirements:

  • 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.

Example

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('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)

Output:

                   date      open      high       low     close  volume  \
0   2019-11-19 23:15:00  1.107875  1.108050  1.107725  1.107825      -1
1   2019-11-20 00:00:00  1.107825  1.107925  1.107675  1.107825      -1
2   2019-11-20 01:00:00  1.107825  1.107975  1.107675  1.107875      -1
3   2019-11-20 02:00:00  1.107875  1.107975  1.107025  1.107225      -1
4   2019-11-20 03:00:00  1.107225  1.107725  1.107025  1.107525      -1
..                  ...       ...       ...       ...       ...     ...
705 2020-01-02 14:00:00  1.119325  1.119675  1.119075  1.119225      -1

Documentation

The complete API documentation.

Changelog.

Discussion

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!)

Disclaimer

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 <ewald.de.wit@gmail.com>

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

ib_insync-0.9.71.tar.gz (69.1 kB view details)

Uploaded Source

Built Distribution

ib_insync-0.9.71-py3-none-any.whl (71.9 kB view details)

Uploaded Python 3

File details

Details for the file ib_insync-0.9.71.tar.gz.

File metadata

  • Download URL: ib_insync-0.9.71.tar.gz
  • Upload date:
  • Size: 69.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.6

File hashes

Hashes for ib_insync-0.9.71.tar.gz
Algorithm Hash digest
SHA256 c1be16a8f23640ddd239f776bd025e5e0a298491b138f05da5b3391f6a6f9bf5
MD5 148fcfcc83446d78269308d83c18ae47
BLAKE2b-256 5edceffa0ab9f40ce6691c76bcf23af3a670d30849b567e6504be1f9e0b13395

See more details on using hashes here.

File details

Details for the file ib_insync-0.9.71-py3-none-any.whl.

File metadata

  • Download URL: ib_insync-0.9.71-py3-none-any.whl
  • Upload date:
  • Size: 71.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.6

File hashes

Hashes for ib_insync-0.9.71-py3-none-any.whl
Algorithm Hash digest
SHA256 86b55d97558e6aeec4d2367e7bc7fed41e96522cb69b3c35cae45cc48e0829ef
MD5 aef43dc194f4476ce53a4b2a26b1b523
BLAKE2b-256 b33f05877b65c08fa2abafc0acc8f3cae499a13c20e78ccd537eacad88ec994e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page