Interactive Brokers’ 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.
An active Interactive Brokers account is required in order to use the Client Portal API. If you do not already have an account, you can create one for free. Please note that you will have to wait for the account to be fully activated before connecting to the API.
The Client Portal API supports only IBKR Pro accounts.