Skip to main content

2. Install Interactive Brokers TWS

XeroLite requires Interactive Brokers Trader Workstation (TWS) or IB Gateway to connect to your Interactive Brokers account. This section guides you through downloading, installing, and launching TWS for the first time.

2.1: Download IB Trader Workstation (TWS)​

Download Options​

You have two options for connecting to Interactive Brokers:

  • TWS (Trader Workstation): Download TWS – Full trading platform with charts and tools
  • IB Gateway: Download IB Gateway – Lightweight API-only connection

Which Should You Choose?​

  • TWS: Full trading platform with charts and tools. Use if you need visual interface.
  • IB Gateway: Lightweight API-only connection. Recommended for automated trading.

Note: Both applications require an Interactive Brokers account. Open an account if you don't have one.

Version Compatibility​

XeroLite VersionIB Gateway/TWS Compatibility
Version v1.1.0Optimized for Trader Workstation/IB Gateway v10.30.1
Tested up to v10.37.01
Version v0.3.3Optimized for Trader Workstation/IB Gateway v10.30.1
Tested up to v10.33.01

Important Notes​

  • Upgrading beyond v10.33.01 may cause minor issues, especially with major version upgrades.
  • XeroLite will continue to provide updates to stay compatible. Please update XeroLite as needed for smooth operation.

2.2: Install TWS​

Windows Installation​

  1. Download the TWS installer for Windows
  2. Run the installer executable
  3. Follow the installation wizard
  4. Choose installation directory (default is recommended)
  5. Complete the installation

Linux Installation​

  1. Download the TWS installer for Linux
  2. Make the installer executable: 
    chmod +x tws-latest-linux-x64.sh
  3. Run the installer: 
    ./tws-latest-linux-x64.sh
  4. Follow the installation prompts
  5. Complete the installation

Mac Installation​

  1. Download the TWS installer for Mac
  2. Open the downloaded .dmg file
  3. Drag TWS to Applications folder
  4. Complete the installation

2.3: Launch TWS for the First Time​

Initial Launch Steps​

  1. Launch TWS from your desktop shortcut or applications folder
  2. Login Screen: Enter your Interactive Brokers username and password
  3. Select Account Type: Choose between Paper Trading or Live account
  4. First-Time Setup: Complete any initial setup wizards if prompted
  5. Verify Connection: Ensure TWS connects successfully to Interactive Brokers

Post-Launch Configuration​

After launching TWS for the first time, you'll need to configure API settings for XeroLite. This is covered in the Configure IB TWS for API Access guide.

Next Steps​

Once TWS is installed and running, proceed to:

Need more help? Contact support at [email protected]

See also: