TradeConsole
TradeConsole
Sign In with Google →
Home / Help Center /Interactive Brokers (IBKR)
~5 min

🌐 Connecting Interactive Brokers (Client Portal & Web API)

Connect Interactive Brokers via the local Client Portal REST Gateway (localhost:5000) or IBKR OAuth Web API access tokens.

🌐 Interactive Brokers Connection Modes

TradeConsole supports Interactive Brokers (IBKR Pro & Lite) through IBKR’s official REST Client Portal API — either via the local Java Client Portal Gateway when running TradeConsole on your workstation, or via an IBKR OAuth Web API Bearer Token.

1

Option A: Local Client Portal Gateway (localhost:5000)

  1. Download the official Client Portal API Gateway zip from Interactive Brokers’ Campus / GitHub portal (requires Java JRE 11+).
  2. Start the gateway from your terminal: bin/run.sh root/conf.yaml (macOS/Linux) or bin\run.bat root\conf.yaml (Windows).
  3. Open https://localhost:5000 in your browser, accept the local self-signed TLS prompt, and log in with your IBKR username, password, and IB Key mobile push until you see “Client login succeeds”.
  4. Set IBKR_ENABLED=true and IBKR_BASE_URL=https://localhost:5000/v1/api in your local .env (with IBKR_VERIFY_SSL=false for IBKR’s localhost self-signed cert).
2

Option B: IBKR Web API OAuth Bearer Token

If your IBKR account is enrolled in the headless IBKR Web API (https://api.ibkr.com/v1/api), configure IBKR_ENABLED=true, IBKR_BASE_URL=https://api.ibkr.com/v1/api, IBKR_VERIFY_SSL=true, and provide IBKR_ACCESS_TOKEN. TradeConsole automatically discovers sub-accounts, handles IBKR What-If order previews, and supports native Parent-Child conditional orders.