How to install the TWS API Components on Mac / Unix

NOTE: If you have already agreed to the API License Agreement please start at Step 3 below.

Instructions

  1. Click directly on the button below to access the API software download page. 
  2. This will direct you to Interactive Brokers API License Agreement, please review it.
  3. Once you have clicked "I Agree", refer to the Mac / Unix section to download the API Software for your o.s.
    API Software Download List
  1. This will download twsapi_macunix.n.m.zip to your computer.
    (where n and m are the major and minor version numbers respectively)
  2. Open Terminal (Ctrl+Alt+T on most distributions)
    (On Mac press Command+Space to launch Spotlight, then type terminal and press Return)
  3. Navigate to the directory where the installer has been downloaded (normally it should be the Download folder within your home folder) and confirm the file is present.

     $  cd ~/Downloads
     $  ls

  1. Unzip the contents the installer into your home folder with the following command (if prompted, enter your password):
    $  sudo unzip twsapi_macunix.n.m.zip -d $HOME/
    Installation directions Step 3 and Step 4
  2. To access the sample and source files, navigate to the IBJts directory and confirm the subfolders samples and source are present.
    $  cd ~/IBJts
    $  ls
    Installation directions Step 5
 

 

Legacy Instructions - API Version ≤ 9.71

Note: IB only offers API Version 9.72+. In the event you already have an existing legacy version and need to install it, please refer to the directions below:

  1. locate the file twsapi_macunix.n.m.jar on your computer.
    (where n and m are the major and minor version numbers respectively.)
  2. Open Terminal (Ctrl+Alt+T on most distributions)
    (On Mac press Command+Space to launch Spotlight, then type terminal and press Return)
  3. Navigate to the directory where the .jar file has been located (normally it should be the Download folder within your home folder) and confirm it is present.
    cd ~/Downloads
    $  ls
  4. Extract the contents of the .jar file into your home folder.
    $  jar xf twsapi_macunix.n.m.jar -d $ HOME/
  5. To access the sample and source files, navigate to the IBJts directory and confirm the subfolders samples and source are present.
    $  cd ~/IBJts
    $  ls
 
 

Additional Information 

You can as well refer to KB2222 for video instructions on installing the Legacy API Components on a Mac.

 

How to restore TWS settings from external storage

Overview: 

This article outlines the procedure for restoring TWS settings from an external location, example external hard drive, USB or other file location.

To restore TWS settings from an external source:

1. Log into TWS

2. Click on File and select Settings Recovery

Menu: File -> Settings Recovery                                     

3. Select Custom and click on Ok

Settings Recovery options                                                                                                                    

4. In the Look in field click on the drop down menu and select the directory where the TWS settings file is stored, example; If the file was located on the Desktop you would scroll to Desktop as shown below                                     Choose settings file location                                                              

5. Once you are in the directory containing the settings file,  select the settings file, example tws.xml and click on Open.

Enter settings filename

6.  In the Open settings confirmation window select Open without reporting problem

settings confirmation

 

See KB3146 for instructions on overcoming the "Downloading settings from server failed" error

See KB2320 for instructions on transferring settings from one user to another

See KB2282 for instructions on how to transfer settings from one computer to another

 

 

 

 

How to transfer TWS settings from on user to another

Overview: 

This process allows the TWS settings from one user to be exported and then imported to another user.

This article applies to:

  • Platform(s): Windows, Mac, Linux
  • TWS Build(s): 936 or later

To transfer settings from one user to another:
 

1. Log into TWS with the user whose settings you would like to export:

  •  Navigate to 'File' and select 'Save Settings As'

       File -> Save Settings As      

  • In the 'Save Settings As...' window, select the drop down arrow and choose a directory/location where you want to save the settings file, example; 'Desktop'.      

      Select Desktop

  • Provide the file name of your choosing and click on Save

2. Log into TWS with the user in which you would like the settings imported:

  • Once logged into the second user Navigate to 'File' and select 'settings recovery' or 'Open settings file'File -> Settings Recovery
  • Select 'Custom' and click on 'Ok'                                                    
    Choose custom
  • In the 'Look in' field select the drop down arrow and navigate to the directory of the settings file you saved from the first account.
  • Select the settings file and click on 'Open'
  • Select 'Open without reporting problem'

 

See KB2323 for instructions on how to restore TWS settings from external storage

See KB2282 for instructions on how to transfer settings from one computer to another.

See KB3146 for instructions on how to overcome the "Download settings from server failed" error

 

 

How to install MobileTWS on BlackBerry OS10

Background: 

Currently, Interactive Brokers does not offer a native IBKR Mobile app for the Blackberry 10 Operating System. Due to a recent partnership between Amazon and Blackberry, clients who own a Blackberry device running Blackberry 10 OS can install the Android version of the IBKR Mobile app directly from the Amazon Store.

Blackberry 10 OS Devices:

  • Q5, Z3, Leap, Classic, Passport, Q10, Z10, Z30, P'9982, P'9983
     

 *Please notice that these devices have limited hardware capabilities and this could negatively affect the performance of the IBKR Mobile app.

 

Installation

You can download the IBKR Mobile app on your Blackberry phone directly from the Amazon Appstore.

 

How to install IBKR Mobile from the Amazon App Store:

  1. On your Blackberry phone open the Amazon App Store  app.
  2. Enter your Amazon e-mail and password, and tap Sign in.
    (If you don't have an Amazon account, tap Create a new Amazon account.)
     
     
  3. Tap on the search bar at the top, type IBKR Mobile then tap Search.
  4. Tap on IBKR Mobile from the search results and install.
   
 
5. Once installed, tap on the IBKR Mobile app from one of your home screens to launch it
   

 

 

How to transfer TWS settings from one computer to another

Overview: 

 This article applies to:

  • Platform(s): Windows, Mac, Linux
  • TWS Build(s): Build 936 and Above

 

Background: 

Store settings on server allows clients the ability to store their Trader Workstation (TWS) settings/configuration on Interactive Brokers (IB) servers and retrieve them at anytime from another computer. This feature allows you to transfer settings from the same user on two different machines, but not between different accounts/users.

 
'Store' Settings on Server:

To transfer settings from one computer to another for the same username you will need to enable the option Use/store settings on server:

1. On the computer which currently has your settings, log in with the Use/store settings on server option unchecked on the login window

 TWS Login Screen

 2. Once you are logged in, enable this function:

  • If you are using the Classic layout, navigate to Edit >> Global Configuration >> Lock and Exit and check the box Use store settings on server
  • If you are using the Mosaic layout navigate to File >> Global Configuration >> Lock and Exit and check the box Use store settings on server

 Global Configurations Window

3.  Select Apply and OK.

4. Click on File -> Save Settings.

5. To Exit the application navigate to File and Exit.

IMPORTANT NOTE: The above operation will only save one copy of the TWS settings on the server. The serve does not store any backup copies.

 

'Use' Settings on Server:

On any computer (on which you want to use the same settings as above): Login with the Use/store settings on server option checked on the login window. This will download the settings, which you previously saved on our server.

 TWS Login Screen

 

 

See KB2323 for instructions on how to restore TWS settings from external storage

See KB2320 for instructions on transferring settings from one user to another

 

 

Syndicate content