IntroductionCopy Location
Copy Location
Interactive Brokers (IBKR) RESTful Web API is designed to provide users with seamless, secure, and real-time access to their IBKR account. The Web API runs parallel to the IBKR hosted application, providing users with scalable, and efficient access to essential services. Our API is split into two key components:
- Account Management: Provides solution for Introducing Brokers and Financial Advisors to preserve their current user experience and interface design while relying on IBKR’s brokerage services. Advisors and brokers can integrate with the Account Management API to manage Client Registration, Client Account Maintenance, User Authentication, Funding, and Reporting.
- Trading: Our trading API is available to all IBKR clients free of cost and can be used to manage trades, view real-time portfolio information, access market data, view contract information, and authenticate for brokerage sessions.
ConnectivityCopy Location
Copy Location
IBKR’s Web API implementation follows standard HTTP verbs for communication. It employs a range of HTTP status codes and JSON-formatted messages to convey operation status and error information. To ensure secure communication, all API requests must use HTTPS. Authorization and Authentication for IBKR’s Web API is managed using OAuth 2.0.
AuthenticationCopy Location
Copy Location
IBKR only supports private_key_jwt client authentication as described in RFC 7521 and RFC 7523.
- Client authenticates against the authorization server by presenting a signed JWT token called a client_assertion which the authorization server validates against the public key(s) provided by the client during registration.
- This scheme is considered safer than the standard client id/client secret authentication scheme used in early OAuth 2.0 integrations given that it prevents the client from having to pass the client secret in back-end requests.
Data TransmissionCopy Location
Copy Location
User requests will be sent to IBKR in JSON format using HTTPS.
ReferencesCopy Location
Copy Location
We know that great documentation makes all the difference. In addition to IBKR’s dedicated API Integration team, IBKR provides documentation for both the developer AND project managers.
- Documentation: Within our long form documentation we include best practices, flow charts, and descriptions to help users maximize the API’s potential.
- Reference: Our API reference includes detailed endpoint references, schema requirements, authentication guides, and sample request and responses.
Getting StartedCopy Location
Copy Location
RetailCopy Location
Copy Location
For retail and individual clients, Authentication to our WebAPI is managed using the Client Portal Gateway, a small java program used to route local web requests with appropriate authentication. Click here to get started.
Institutional or Third PartyCopy Location
Copy Location
We understand that enterprise integrations can be more complex. We have a designated API Solutions team that will help in creating solution that aligns with your business objectives. To get started, please contact our API Solutions (e-mail: api-solutions@interactivebrokers.com) with the following information:
- Firm Name
- Firm Type (ie. Introducing Broker, Financial Advisor OR Third Party Service Provider)
- API Services which you are interested in using (ie. Registration, Funding, Single Sign On, View Portfolio Data, Trading, Reporting)
- Describe intended usage (1-2 sentences)
FeedbackCopy Location
Copy Location
Have feedback on our Web API documentation or reference material?
Email us at API-Feedback@interactivebrokers.com.
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.
View our Web API Trading or Account Management documentation.