Installation

Install

Use pip to install IBind in your project.

pip install ibind

Automate The Gateway

You need to have a running Java-based Client Portal Gateway in order to successfully communicate with the IBKR CP Web API.

We recommend using IBeam to automate and simplify starting the Gateway and keeping it alive.

IBeam (the authentication tool) is also built and maintained by the authors of IBind (this Python client library), and the two projects are meant to support one another.

Verify the Installation

Once you have an authenticated Gateway running, verify the IBind installation by running:

from ibind import IbkrClient

print(IbkrClient().tickle())

---

Next

To get started, familiarise yourself with the Basic Concepts.

Above code snippet expects the Gateway URL to be the default https://localhost:5000/v1/api/, which may not be the case in your setup. You can learn more about configuring this and other settings in IBind Configuration.