Installation & Authentication

Create an IBKR Account

If you have not already, create and fund an IBKR Pro account.

Install Java

If you do not have a working version of Java, download it from the official website.

You can check if you have a working installation of Java by running the following command in the terminal: java -version

Download the Client Portal Gateway

Unzip the downloaded file.

Run the API Gateway

In the terminal navigate to the unzipped, clientportal.gw directory. For example: cd C:/Users/Example/Downloads/clientportal.gw

Launch the gateway using the following command: bin\run.bat root\conf.yaml

Log In

Navigate to https://localhost:5000. Log in using your standard Interactive Brokers credentials.

Initialization

A brokerage session is required for endpoints prefixed with the /iserver path. To initialize a brokerage session, send a request to the /iserver/auth/ssodh/init endpoint containing {"publish":true,"compete":true} in the body.