{"id":175997,"date":"2021-04-28T18:59:00","date_gmt":"2021-04-28T22:59:00","guid":{"rendered":"https:\/\/ibkrcampus.com\/trading-lessons\/introduction-to-the-tws-excel-api-initial-setup\/"},"modified":"2023-04-25T20:56:08","modified_gmt":"2023-04-26T00:56:08","slug":"introduction-to-the-tws-excel-api-initial-setup","status":"publish","type":"trading-lessons","link":"https:\/\/www.interactivebrokers.com\/campus\/trading-lessons\/introduction-to-the-tws-excel-api-initial-setup\/","title":{"rendered":"Introduction to the TWS Excel API & Initial Setup"},"content":{"rendered":"

Prerequisites<\/strong><\/h4>\n

Microsoft Office Excel (Windows Only)<\/a><\/p>\n

Java Runtime Environment (JRE)<\/a><\/p>\n

Before we begin, there are some prerequisites the TWS API requires. For example, if are looking to use our excel APIs, you would need Java and a Windows copy of Microsoft Excel installed.<\/p>\n

Overview of the TWS API<\/strong><\/h4>\n

The Interactive Brokers’ TWS APIs allows other applications and programs to work with the Trader Workstation (TWS) or IB Gateway. Trader Workstation is our flagship trading platform and IB Gateway is the lightweight<\/strong> version without any of the manual trading features.<\/p>\n

In this course, we will cover connecting Microsoft Excel to TWS so we can retrieve market data, place orders, view account and portfolio data and much more! We’ll explore a sample spreadsheet that has been created by IBKR to highlight the functionality of the Excel TWS API. You can reference the sample spreadsheet as we show you examples in this course. We’ll also cover making an API request, such as retrieving market data, using a blank Excel spreadsheet. This way you’ll know how to connect your existing spreadsheet with TWS.<\/p>\n

Let’s briefly cover the TWS API a bit more in depth, and its capabilities.<\/p>\n

Downloading and installing TWS<\/h4>\n

Before we get started, make sure you have TWS or IB Gateway installed, If you don’t, you can head over to our website, ibkr.com<\/a>, select “Log In” in the upper right hand corner of the page and from the drop down menu, select Trader Workstation or API: IB Gateway.<\/p>\n

They can also be found on our main website, under the menu Trading, then Platforms.<\/p>\n

In addition, there are some prerequisites the TWS API requires. For example, if are looking to use our excel APIs, you would need Java and a Windows copy of Microsoft Excel installed.<\/p>\n

The latest version of our Excel APIs are supported with both 32-bit and 64-bit Operating Systems. However, they are not compatible with the Mac Operating System. Our website will automatically provide a download version but you may choose a different version if you’d like.<\/p>\n

Installing the TWS API<\/h4>\n

To obtain all the components required to use the Excel APIs, including sample sheets and source code, on our website, you may navigate to ibkr.com <\/a>and access the menus at the top and select Trading > APIs<\/strong> and select Download and Resources<\/strong>.<\/p>\n

Our APIs are provided with a Non-Commercial license agreement. You may download either the stable or latest version.<\/p>\n

Note, the Excel APIs are only supported for the windows operating system.\u00a0 The most up-to-date version of Interactive Brokers API source code is hosted on Github<\/a> as a private repository. We refer to this as our “beta client” although it doesn’t use formal release numbers as do our “Latest” and “Stable” API versions.<\/p>\n

This code is frequently updated with new features and functionality, and periodically the API source code in this private repository is published as a new version of API Latest. Users can gain access to the Github<\/a> repository to view the current Beta API source code as well as to contribute suggestions and source code.<\/p>\n

Our goal in allowing our users to contribute is to improve the reliability and versatility of the API for everyone.\u00a0 Review this page if you\u2019d like to access and contribute to the API Beta version.<\/p>\n

After successfully installing, you will find the API samples and components installed on the same drive as the operating system which is usually the c drive.<\/p>\n