Access to endpoints containing /iserver, which are used to place orders and receive market data, require a brokerage session. The endpoint /iserver/auth/status will return the status of your Web API brokerage session via its "authenticated" field. A response containing…

We encourage you to review our Web API documentation on IBKR Campus.

The IBKR API support team can be contacted through the iBot Feedback Tool or by creating a ticket in the Client Portal Message Center…

When seeking assistance with our Web API, please provide our API Support team with logs of your HTTP requests and responses, including all headers. It is often helpful not only to provide details of the specific request at issue, but also to provide logs of all previous requests and responses in the session…

Gaining access to the Web API can be automated only when employing token-based authentication schemes such as OAuth. Individual clients using the CP Gateway tool must complete a manual login with their IBKR username and password…

Clients accessing the Web API using our CP Gateway tool must complete a manual login with their IBKR username and password, which in turn requires 2FA.

Institutional clients who access the Web API via token-based authentication methods like OAuth do not need to use 2FA…

All IBKR clients may access our Web API, provided they have fully open and funded accounts, or are using Free Trial or testing accounts provided by a Sales Representative…

A brokerage session exists between an authenticated/logged-in client platform (such as Trader Workstation, or your Web API client application) and IBKR's backend trading infrastructure. Authentication relies on an IBKR username, and once authenticated, that username is said to have established a brokerage session on that platform in use…

Organizational account holders may make requests directly to IBKR infrastructure. Several methods of request authentication are available, including OAuth 1.0a, OAuth 2.0, and SSO.

Individual, retail account holders must make requests via the CP Gateway…

You can find a list of endpoints available via the Web API here…

Please click here to view documentation for IBKR's Web API…

IBKR's Web API makes use of two nested sessions.

• The first session layer grants "read-only" access to your account structure but does not permit use of any /iserver endpoints. At this stage, no trading or consumption of paid market data is possible, though you may still access portfolio data. This first layer is a prerequisite for the second…

The endpoint /iserver/auth/status will return the status of your Web API brokerage session via its "authenticated" field. A response containing "authenticated": "false" indicates that no Web API brokerage session currently exists for the requesting username, while…

Our CP Gateway tool is essentially an HTTP web server acting as a reverse proxy, forwarding your requests to IBKR. It ships with a stock, placeholder certificate that is expired. The CP Gateway is meant to be deployed locally, on the same device or local network as the request originator. You may substitute a self- or officially-signed certificate if you choose…