Close Navigation
Learn more about IBKR accounts


After clients connect with Interactive Brokers, many find that they would like to integrate with Interactive Brokers’ API offerings. This might be to automate trading, exploring alternative graphical interfaces, or perhaps to build connections for other users. In this guide, we will look to explore what is offered by Interactive Brokers, what might not be available, and details on how to get started with each implementation.


Interactive Brokers is merging our web-based API products into a single, comprehensive IBKR Web API, bringing the features of the Client Portal Web API, Digital Account Management, and the Flex Web Service together in a unified interface, accessible by a shared means of authorization and authentication: OAuth 2.0.

Existing endpoints and authentication schemes are not deprecated and will continue to receive features and updates. Rather, we look forward to providing our clients with a new, coordinated set of endpoints exposing the same backend resources. At the same time, to support this orchestration, IBKR Campus will present documentation for the Client Portal Web API, Digital Account Management, and the Flex Web Service side by side under the Web API umbrella.

To the right, you will find links to consolidated documentation and reference material for our unified Web API. Additionally, we provide direct links below to documentation for the Web API’s three constituent feature sets: the Client Portal Web API, Digital Account Management, and the Flex Web Service.

Web API Documentation Web API Reference

Have feedback on our Web API documentation or reference material? Email us at We value your suggestions, ideas, and feedback in order to continuously improve our API solutions.

This is an automated feedback inbox and unfortunately, we will not be actively responding from this email. However, if you need a specific answer or additional support, please contact our API Support team or access our general support. Current or prospective institutional clients may also contact their sales representative.

Legacy Documentation

Client Portal Web API
The Client Portal Web API delivers real-time access to Interactive Brokers’ trading functionality, including live market data, market scanners, and intra-day portfolio updates. Clients can communicate directly with IBKR infrastructure, both synchronously using RESTful HTTP endpoints and in an asynchronous, event-driven manner via websocket. A variety of authorization and authentication methods are available to accommodate any use case, including OAuth 1.0a, OAuth 2.0, SSO, and our Java-based CP Gateway tool.

Digital Account Management
Digital Account Management, or DAM, is a web-based API that allows Financial Advisors and Introducing Brokers to create and manage client accounts programmatically. It also offers the ability to provide clients with whitebranded access to the Account Management functionality of our Client Portal, so clients can manage their own accounts directly.

Flex Web Service
The Flex Web Service is a small API used to programmatically retrieve client-configured statement and reporting data, call Flex Queries.

Client Portal Web API Documentation Digital Account Management (DAM) Documentation Flex Web Service Documentation

TWS (Trader Workstation) API

Interactive Brokers’ flagship platform, the Trader Workstation, is equipped with it’s own API offering the majority of its feature set through an API built for fast paced, data intensive, and complex trading. The asynchronous TWS API library is built to handle a large data sets for hundreds or potentially thousands of market data lines streaming simultaneously while outputting trades in tandem. Given the platform is equipped with the Trader Workstations’ capabilities, we have nearly full parity with the functionality, order type access, and market data access you may be used to. This can be further extended with the less demanding IB Gateway, as the removal of unused graphical elements from automated trading can allow more resources be dedicated to your unique programs.

The TWS API is built using a TCP Socket connection, and is available in Python, Java, C++, C#*, and VB.NET*.

The TWS API is intended for: Retail traders, Professional Traders, Financial Advisors, and Third Party Platform developers.

*C# and are only available for Windows PC.

TWS API Documentation TWS API Reference

Excel APIs

Interactive Brokers also offers an array of Excel-based APIs built around the underlying TWS API. This makes for a more visually appealing workspace for those that prefer a data table presentation rather than fully automated workflows. The Excel API still institutes the same functionality as TWS API including the order types, order conditioning, and market data availability.

The Excel API is built with a DDE, ActiveX, or RTD connection onto the TCP Socket connection facilitated by the standard TWSAPI.

While the existing Excel functionality can be programmed with VB.NET, the underlying connection and request behavior is handled in Java for DDE, or C# for ActiveX and RTD.

Trader Types: Retail traders, Professional Traders


Interactive Brokers’ offers three unique variants of Excel connectivity. ActiveX offers the full functionality of the TWS API with a 1 second market data refresh rate. Implementing the ActiveX variant will require users to implement some level of VB .NET as the cell assignment can not be done completely through the use of something like an Excel Macro.

ActiveX is built using a combination of VB .NET and C#.

ActiveX Documentation


Interactive Brokers’ offers three unique variants of Excel connectivity. DDE offers the full functionality of the TWS API with a 250 ms market data refresh rate. Implementing the DDE variant allows users the full functionality of the TWS API but with access to Excel Macros for a less programming-intensive implementation.

DDE is built using a combination of VB .NET and Java.

DDE Documentation


Interactive Brokers’ offers three unique variants of Excel connectivity. RTD offers a more restricted connection structure that is built around the use of requesting real time market data. As such, the RTD variant is built around the intake of larger market data requests without effecting Excel’s performance. The implementation allows for a 250 ms market data refresh.

RTD is built using a combination of VB .NET and C#.

RTD Documentation

FIX (Financial Information eXchange)

In addition to our standard APIs, Interactive Brokers also offers our customers the option for a direct FIX integration, allowing trades be submitted directly using the standard FIX protocol. For users unfamiliar with the FIX standard, please visit

Trader Type: Professional Traders, Organizations, or Institutions.

Getting Started With FIX

Third-Party Integrations

For some customers, Trading with Interactive Brokers is the preferred option, but in some cases users may not prefer our existing platforms, nor do they have an interest in coding their own software. In these cases, customers may benefit from using Third Party Services or Software to accomplish their trading needs. For example, some customers may wish to trade futures with a more chart oriented approach, or with a platform more emphatic around Futures than what is currently offered by Trader Workstation. In situations like this, customers may find a platform that better supports their visual needs while still holding funds and receiving commission rates through Interactive Brokers.

Third Party Services can connect via Client Portal API, FIX, or Trader Workstation API.

Trader Types: Retail traders, Professional traders

Third Party Connections

IBKR Campus Newsletters

This website uses cookies to collect usage information in order to offer a better browsing experience. By browsing this site or by clicking on the "ACCEPT COOKIES" button you accept our Cookie Policy.