If you use RSA encryption in file exchange communication with Interactive Brokers, best practice requires that this key be backed up for security and retrieval purposes. Creating a backup is quick and ensures the longevity of your Key Pair.

Note: this tutorial assumes you have already set up a Key pair. If you need guidance to set up the Key pair please refer to this article, which is a prerequisite to the instructions below.

Please select one of the below links, according to your Operating System:

• Windows
• macOS

Windows

1. Launch the application Kleopatra and select the encryption key you want to transfer. Then right-click on the selection and choose Backup Secret Keys...

Note: Do NOT use Export..., as this will only export the public part of the Key while you need to have a backup of both public and private parts.

2. Select a folder of your preference (e.g. Desktop) and a file name of your preference (e.g. secret-key-KEYID.asc) for your backup copy. Then click Save. 

3. Enter the passphrase you have set when you created the Key and click OK.

4. A pop-up will confirm the backup has been successfully created. Click OK.

macOS

1. On the machine where the encryption keys are stored, create a new folder (e.g., on your Desktop).

2. Launch the application GPG Keychain and select the encryption key you want to transfer. Please make sure that Sec/Pub is indicated in the Type column.

3. Click the icon Export on the top toolbar. In the field Where, select the folder you previously created. Make sure to check Include secret key in exported file and then click Save as illustrated in the above screenshot.

4. A backup copy of the key pair will be created in the folder you selected.

These instructions apply to users who are receiving their statements via sFTP. If you elected to receive your statements that way, you would first need to generate an RSA Key pair. If you need guidance to set up the Key pair, please refer to this article, which is a prerequisite to the instructions below.

1. Start WinSCP.

2. Click on Session and select New Session.

• xfer.interactivebrokers.com in the Host name field.
• 32 in the Port number field.
• The username provided to you by Interactive Brokers in the User name field.

Select SFTP as File protocol:

4. To ensure the session is using the appropriate Private Key file, Click Advanced > Authentication. Verify that the Private Key file field has the appropriate Key file selected. Click OK.

5. Click Login to connect with the sFTP host and retrieve reports in clear text.

6. Drag documents from the right side panel (sFTP host site) to the left side panel (local machine host).

Common issues and solutions

1. Ensure the correct login details are being used to connect to the sFTP server. The username and password you are entering should match the ones you have received from the Reporting Integration Team.
2. Confirm you have configured your sFTP Client to use the Private Key file for the logon authentication (see step 4. of the above procedure.)

1. Try accessing the sFTP server using a different Client (FileZilla, WinSCP, CyberDuck, ect.)
2. Ensure the Private Key file being used to Authenticate the server login attempt is related to the Public Key you originally sent to the Reporting Integration Team.
3. Should the above checks be unable to resolve the issue, please generate a new RSA Public/Private Key pair and send only the Public part to the Reporting Integration Team, as per IBKB3842.

1. In case you have an antivirus or a security software installed on your machine, make sure it is not blocking the FTP connection attempt. Normally, security software allows to set up exceptions for specific connections in order to whitelist them.
2. Verify that the public IP Address of the machine running the sFTP client, is the same you have originally provided to the Reporting Integration Team for being whitelisted. You can discover your public IP Address by searching the Internet for “what is my IP”. If your current IP Address is not the same you provided to us, please send it to our Reporting Integration Team for being whitelisted.
3. Ask your network administrator/s to confirm that your firewall allows both incoming and outgoing traffic from/to xfer.interactivebrokers.com on port TCP 32.
4. Should the above steps be unable to resolve the issue, please generate a new RSA Public/Private Key pair and send only the new Public part to our Reporting Integration Team, as per IBKB3842.

Tick Size Pilot ("TSP" or "Pilot") Program:

Under the TSP Program,  if IBKR receives any order in a Pilot Security that does not conform to the designated pricing increment (e.g., a limit price in a $0.01 increment for a security designated as trading $0.05 increments), IBKR will REJECT that order, subject to limited exceptions. IBKR strongly encourages a thorough review of your software or your vendor’s software to understand the criteria for what causes an order in a Pilot Security to be rejected to permit you or your vendor to make changes to correctly handle orders in Test Group Pilot Securities.
 

FREQUENTLY ASKED QUESTIONS:

Q: What is the Tick Size Pilot?
A: On May 6, 2015, the SEC approved an amended TSP NMS Plan. The Pilot will be two years in length. Data collection for the Pilot began on April 4, 2016, 6 months prior to the implementation of the trading and quoting rules for the Pilot. Implementation of the trading and quoting rules for the Pilot will begin on October 3, 2016.

The Pilot will be conducted using a Control Group and three Test Groups where variations in quoting and trading rules exist between each group. Please see the TSP NMS Plan for additional information.

Q: Will the Pilot quoting and trading rules apply during regular market hours, pre-market hours and post market hours?
A: The Pilot rules apply during all operational hours (pre-market, regular hours, and post market hours trading).

Q: Will the Pilot quoting and trading rules apply to odd-lot and mixed-lot sizes?
A: Yes, the Pilot rules to all order sizes.

Q: Will orders in Control Group Securities be accepted in price increments of less than $0.05?
A: Yes, orders submitted in price increments of less than $0.05 will continue to be accepted in Control Group securities.

Q: Will orders in a Test Group 1, 2 or 3 Pilot Securities be accepted in price increments of less than $0.05?
A: No, unless covered by an exception, orders submitted in price increments of less than $0.05 will be rejected.

Q: Which Pilot Security Orders in Test Groups will Interactive Brokers accept at other than $0.05 increments?
        Midpoint orders with no explicitly stated limit price or impermissible offsets will be accepted
        VWAP orders that do not have an explicitly stated limit price or impermissible offsets will be accepted.
        Interactive Brokers will accept Exchange operated Retail Price Improvement orders as follows:
                  Test Group 1 in $0.001 price increments
                  Test Groups 2 and 3 in $0.005 price increments.

Q: Will there be any changes to the Opening / Closing processes on Exchanges?
A: Please refer to each of the exchange rules for details but in general, there will be no changes to the Opening / Closing process. All orders entered and eligible to participate in Exchange Opening / Closing Cross will be accepted in increments of $0.05. The Exchanges will begin publishing all quotes in increments of $0.05; however, Net Order Imbalance Indicator prices may be published in increments of $0.025.

Q: What will happen to my GTC order that was placed prior to October 3^rd in a Pilot Stock that was priced in impermissible tick increments?
A: Interactive Brokers will adjust outstanding limit and stop GTC orders in Pilot stocks in Test Groups that are not in permissible tick increments (e.g., a buy limit order at $5.01 will be adjusted to $5.00 and a sell limit at $5.01 adjusted to $5.05).

Q: What will happen to my GTC order placed after October 3^rd that was placed and accepted in a nickel tick increment but the Pilot Stock moves from a Test Group to the Control Group that permits non-nickel increments?
A: The GTC order will automatically be able to be revised by the user in non-nickel increments on the date the Pilot stock moves from the Test Group to the Control Group. Similarly, if a stock is added to Test Group due to a corporate action, IBKR will cancel the GTC order if it is priced in impermissible increments.

Q: Where can I find out more information?

A: See KB2752 or the FINRA website for additional details regarding the Pilot Program: http://www.finra.org/industry/tick-size-pilot-program

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
   

4. This will download twsapi_macunix.n.m.zip to your computer
   (where n and m are the major and minor version numbers respectively)
5. Open Terminal (Ctrl+Alt+T on most distributions)
   (On Mac press Command+Space to launch Spotlight, then type terminal and press Return)
6. 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

7. 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/
   
   
8. To access the sample and source files, navigate to the IBJts directory and confirm the subfolders samples and source are present
   $  cd ~/IBJts
   $  ls
   
   

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