Introduction
The Interactive Brokers Web API offers three unique ways to authenticate. These authentication methods are made available based upon client account type and need. The core Trading API functionality is available for all authentication types.
Client Portal Gateway
The standard method of authenticating for authentication for the Web API. The Client Portal Gateway is a Java client that reverse-proxies authentication through SSO.
Supported Account Types
Getting Started
See our Quick Start guide for authenticating with the Client Portal Gateway Our WebAPI Basics Tutorial provides a video format to help get started.
OAuth 1.0a
OAuth 1.0a allows users to authenticate fully programmatically using a custom build of the OAuth 1.0a authentication scheme passing a Live Session Token build by hashing a set of private keys within request headers. OAuth 1.0a is the only supported authentication method for Third Party Developers.
Supported Account Types
- Advisor Accounts
- Broker & FCM Accounts
- Proprietary Trading Group Accounts
- Hedge and Mutual Fund Accounts
- Institutional Hedge Fund Investors
- Third Party Software Developers
Getting Started
See our OAuth 1.0a section for authenticating with the Client Portal Gateway
OAuth 2.0
OAuth 2.0 allows users to authenticate fully programmatically using a modified OAuth 2.0 authentication scheme. Account Management endpoints are only avialable through OAuth 2.0 for Advisor and Broker account types.