Basic Concepts

Core Functionality

IBind's core functionality consists of two client classes:

• IbkrClient - for IBKR REST API
• IbkrWsClient - for IBKR WebSocket API

Their usage differs substantially. Users are encouraged to familiarise themselves with the IbkrClient class first.

Client Portal Gateway Dependency

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.