You need to intall Docker at first to use this repository, as this is a dockerized IBKR Client-Portal Gateway.
When you run docker, the Client-Portal Gateway is automatically downloaded from original IBKR website and automatically used thereafter, so you are guaranteed to be using original IBKR files.
- Download this repo
- Unpack & enter the folder and run:
docker compose up -d --build - Then open
https://localhost:5000in your browser and log in with your IBKR credentials (the certificate is self-signed, so accept the browser warning). - Note: If the port
5000is already occupied (e.g. you have a macOS & AirPlay), at first change the port mapping indocker-compose.ymlfrom"5000:5000"to e.g."5001:5000"before starting it and then use5001port in the browser and also in CCXT you will need to additionally pass that non-default url like instructed here
To see the logs, use docker compose logs -f.
If you want to customize the gateway options, edit config/conf.yaml before running docker.
The session lives in the container's memory. If the container restarts, you need to log in again.
To keep the session alive, your app should call POST /v1/api/tickle periodically.
To force a fresh download of the latest official release:
docker compose build --no-cache
docker compose up -dMIT