Home

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 version of your preference
    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

 

How to Transfer the TWS Layout Settings via USB or Network Drive

Overview: 

The TWS layout settings can be saved on a USB or Network Drive, in order to import them from the same or from a different computer / TWS session. This article outlines the needed steps.

Please click one of the links below, according to your scenario:

A. I want to save my TWS settings on a USB or Network Drive and import them to a session with the same user

B. I want to save my TWS settings on a USB or Network Drive and import them to a session with a different user

 

A. I want to save my TWS settings on a USB or Network Drive and import them to a session with the same user

1. Log in the Trader Workstation with the user whose layout settings you would like to export.

2. Click the top menu File > Layout Settings > Save Settings As...

3. Expand the Look In drop-down and select where you want to save the file (e.g. USB or Network Drive). Use a file name which would be easy to identify (e.g. migrate) and click Save. The file will be saved with the extension '.xml'.

                       

4. Proceed with the workflow, starting with step 5 in the following section.

 

B. I want to save my TWS settings on a USB or Network Drive and import them to a session with a different user

1. Log in the Trader Workstation with the user whose layout settings you would like to export.

2. Click the top menu File > Layout Settings > Save Decrypted Settings As...

3. Take notice of the information about the file format and click Yes.

4. Expand the Look In drop-down and select where you want to save the file (e.g. USB or Network Drive). Use a file name which would be easy to identify (e.g. migrate) and click Save. The file will be saved with the extension '.xml'.


5. Close the TWS and log in again with the user which should import the layout (that can be a different computer).

6. Connect the USB or Network Drive to the computer.

7. Click on the top menu File > Layout Settings > Layout/Settings Recovery...

8. Select Custom... and click OK

9. Expand the Look In drop-down and select the drive where you previously saved the TWS settings file (e.g. USB or Network Drive). Select the settings file (e.g. migrate.xml) and click Open.

10. Click Open without reporting problem

11. Your TWS will automatically restart, applying the new layout settings.

 

Related articles

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 One User to Another

Overview: 

Trader Workstation (TWS) layout settings files contains few sensitive details that are now being protected by encrypting them. Hence, you can only transfer your TWS settings from one user to another if you have a decrypted settings file from the primary user.

In this article, we will explain how to export your current TWS layout settings in decrypted format and load it on a different TWS session. You can use the same procedure to export layout settings of your Paper (Simulated) TWS and load it on your Live TWS (and vice versa).

Please follow the below steps to transfer your TWS layout settings from one user to another:

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

2. Navigate to the top menu File followed by Layout Settings > Save Decrypted Settings As...

3. Click Yes on the warning pop up

4. Open the Look In drop-down and select the folder (e.g. Desktop) where you want the decrypted settings file to be saved

5. Choose a name of your preference (e.g., migrate) and click Save. A pop-up will flash to inform you that the file has been written

6. Restart the TWS. Log in with the user which should import the layout settings

7. In the top left, click on File > Layout Settings > Layout/Settings Recovery

8. Select Custom and click OK

9. Open the Look In drop-down and select the location where you previously saved the decrypted settings file (step 5). Click Open

10. Click Open without reporting problem

11. Your TWS will automatically restart, loading the imported layout settings

 

References

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 959 and Above

 

Background: 

The 'Store Settings on Server' feature stores the Trader Workstation (TWS) settings/configuration in the cloud and retrieve them at anytime from another computer. This allows you to transfer settings from the same user on two different machines, but not between different accounts/users.

 
How to upload your TWS settings to the 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, on the lower right of the login window, click on More Options >TWS Login Screen

2. Make sure the Use/store settings on server option is unchecked and login

 3. 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

4.  Select Apply and OK.

5. Click on File -> Save Settings.

6. 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.

 

How to download your TWS settings from the 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

 

Related articles

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

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