Duration: 2:53
Level: Intermediate

Hello, and welcome to this lesson the Interactive Brokers Client Portal API. In this lesson, we will be discussing what the Client Portal API is, why an individual may use it, and more

Study Notes:

Hello, and welcome to this lesson the Interactive Brokers Client Portal API. In this lesson, we will be discussing what the Client Portal API is, why an individual may use it, and more.

To begin, the Client Portal API is a RESTful API which allows you to make requests to the Interactive Brokers’ systems using standard http requests over the internet as opposed to using a local TCP socket. This system allows for a lightweight application with minimal installation required. The only required prerequisites to run and operate the API is a modern Java installation to run the gateway along with a command prompt. However, in the case of this course’s examples, you will also need to have Python 3 installed, along with the ‘requests’ library. We will also make frequent references to the Python’s JSON standard library; however, this is not required other than general formatting.

I would like to note that we will be proceeding through this series using Python and the ‘requests’ module. Because these requests are referring to standard web requests like a URL, body, or other common fields, these calls are not unique to Python. The same calls can be performed using CURL requests directly, through Javascript, C#, or any other language that supports web requests. If you are more experienced with another, feel free to follow along in your preferred language.

With that said, I would like to provide a few details regarding the use of the Client Portal API rather than the Trader Workstation API. As stated previously, a particular benefit to the Client Portal API, or CPAPI, is the lightweight nature. Without the need to operate the Trader Workstation, we can run a range of code with less demanding hardware requirements. However, it is important to note that the system is much younger than the Trader Workstation API, and while it does have many of the same features, it may not have full parity quite yet. We are adding new data and endpoints all the time, so while something may not exist yet, that does not mean it will not be coming soon.

Thank you for watching this Introduction to the Interactive Brokers Client Portal API. If you found this lesson helpful, please check out our other lessons in the Client Portal API tutorial series. 

API Trading


Latest IB Gateway


Client Portal API Documentation


Available Endpoints


Release Notes


6 thoughts on “What is IBKR’s Client Portal API?”

    1. Thank you, Mohamed. We are glad you found the content helpful! Be sure to check out other lessons on IBKR Campus.

Leave a Reply

Note that all comments are held for moderation before publishing.

Disclosure: Interactive Brokers

The analysis in this material is provided for information only and is not and should not be construed as an offer to sell or the solicitation of an offer to buy any security. To the extent that this material discusses general market activity, industry or sector trends or other broad-based economic or political conditions, it should not be construed as research or investment advice. To the extent that it includes references to specific securities, commodities, currencies, or other instruments, those references do not constitute a recommendation by IBKR to buy, sell or hold such investments. This material does not and is not intended to take into account the particular financial conditions, investment objectives or requirements of individual customers. Before acting on this material, you should consider whether it is suitable for your particular circumstances and, as necessary, seek professional advice.

The views and opinions expressed herein are those of the author and do not necessarily reflect the views of Interactive Brokers LLC, its affiliates, or its employees.

Disclosure: API Examples Discussed

Throughout the lesson, please keep in mind that the examples discussed are purely for technical demonstration purposes, and do not constitute trading advice. Also, it is important to remember that placing trades in a paper account is recommended before any live trading.