Enable the API in IBKR
In TWS or IB Gateway, open API settings, enable socket clients, and authorize the address that will run the Kairox worker. Locally, the address is often 127.0.0.1.
Financial broker
Connect Interactive Brokers to Kairox
Interactive Brokers uses IB Gateway or Trader Workstation. Kairox connects to the local or remote server using a host:port and client ID, then routes compatible financial orders.
Before you start
Prepare the account before creating the connection
Install IB Gateway or Trader Workstation and sign in to your IBKR account.Enable the socket API in IBKR settings.Note the port: often 7497 for paper trading and 7496 for live.
Step 1
Create access on Interactive Brokers
This part happens in the broker or platform interface. The goal is to create credentials dedicated to Kairox, with only the permissions needed for trading.
Choose a client ID
Define a numeric client ID, such as 1. This client ID lets Kairox open a separate API session.
Check the port
Note the host and port in host:port format. Example: 127.0.0.1:7497 for a local paper trading gateway.
Step 2
Create the connection in Kairox
Once access is ready, create the connection from the Kairox dashboard. The system will use it to prepare orders according to market, symbol, and risk limits.
Select Interactive Brokers
In Connect Brokers & Exchanges, choose the financial category, then Interactive Brokers.
Enter the server
In IB Gateway Host:Port, enter the host:port for TWS or IB Gateway. In IB Client ID, enter the numeric client ID you chose.
Add the account if needed
Account ID is optional. Use it if your IBKR session exposes multiple accounts and you want to force a specific destination.
Mapping
Fields to complete in Kairox
Use this mapping to avoid pasting a secret into the wrong field. Labels match the Connect Brokers & Exchanges form.
Security
Rules to check before enabling execution
Keep TWS or IB Gateway open during execution.Use paper trading before connecting a live account.Check IBKR-qualified contracts before automation.
Create the connection
Connect Interactive Brokers from your dashboard
Create or check your keys, then add the connection in Kairox from the user workspace.