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

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.

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.79.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ib_insync-0.9.79.tar.gz
  • Upload date:
  • Size: 68.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for ib_insync-0.9.79.tar.gz
Algorithm Hash digest
SHA256 8b7eeb00e9cbccdef0ffce75b6bcbe9aa105a4d3a302d743aedaef03f1c18c94
MD5 4166867b3585a8ceddcf42cebdcb6cc4
BLAKE2b-256 b0de170f8b2aa28f6712bfed40026c344f9336f863e2c42fb79934cf911ade97

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ib_insync-0.9.79-py3-none-any.whl
  • Upload date:
  • Size: 71.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.0

File hashes

Hashes for ib_insync-0.9.79-py3-none-any.whl
Algorithm Hash digest
SHA256 6c81e063e1942534c8d3916dc2acf068c1bb921c90bdc7cbd496681b7a58451f
MD5 174e2e69ecdde5337c7a82264572be68
BLAKE2b-256 56b7f2337cb6f7786f922401ded2460aab090779ce02c8c514efa6b4f481f76c

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