Repository files navigation

This library is currently being beta-tested. See something that's broken? Did we get somethingwrong?Create an issue and let us know!

IBind is an unofficial Python API client library for theInteractive Brokers Client Portal Web API. (recently rebranded to Web API 1.0 or CPAPI 1.0) It supports both REST and WebSocket APIs of the IBKR Web API 1.0. Now fully headless withOAuth 1.0a support.

Note: IBind currently supports only the Web API 1.0 since thenewer Web API seems to be still in beta and is not fully documented. Some of its features may work, but it is recommended to use the Web API 1.0's documentation for the time being. Once a complete version of the new Web API is released IBind will be extended to support it.

pip install ibind

IBind supports fully headless authentication usingOAuth 1.0a. This means no longer needing to run any type software to communicate with IBKR API.

Alternatively, useIBeam along with this library for easier setup and maintenance of the CP Gateway.

SeeAuthentication page to learn more.

See fullIBind documentation.

• Installation
• Authentication
• OAuth 1.0a
• IBind Configuration
• IbkrClient - REST Python client forIBKR REST API.
• IbkrWsClient - WebSocket Python client forIBKR WebSocket API.
• API Reference

Features:

• REST:
  • Automated question/answer handling
  • Parallel requests
  • Rate limiting
  • Conid unpacking
  • and more
• WebSocket:
  • WebSocket thread lifecycle handling
  • Thread-safe Queue data stream
  • Internal subscription tracking
  • Health monitoring
  • and more

IBind's core functionality consists of two client classes:

• IbkrClient - forIBKR REST API

  Using theIbkrClient requires constructing it with appropriate arguments, then calling the API methods.

• IbkrWsClient - forIBKR WebSocket API

  Using theIbkrWsClient involves handling three areas:

  • Managing its lifecycle. It is asynchronous and it will run on a separate thread, hence we need to construct it, start it and then manage its lifecycle on the originating thread.
  • Subscribing and unsubscribing. It is subscription-based, hence we need to specify which channels we want to subscribe to and remember to unsubscribe later.
  • Consuming data. It uses a queue system, hence we need to access these queues and consume their data.

Their usage differs substantially. Users are encouraged to familiarise themselves with theIbkrClient class first.

Seeall examples.

fromibindimportIbkrClient# Construct the clientclient=IbkrClient()# Call some endpointsprint('\n#### check_health ####')print(client.check_health())print('\n\n#### tickle ####')print(client.tickle().data)print('\n\n#### get_accounts ####')print(client.portfolio_accounts().data)

fromibindimportIbkrWsKey,IbkrWsClient# Construct the client. Assumes IBIND_ACCOUNT_ID and IBIND_CACERT environment variables have been set.ws_client=IbkrWsClient(start=True)# Choose the WebSocket channelibkr_ws_key=IbkrWsKey.PNL# Subscribe to the PNL channelws_client.subscribe(channel=ibkr_ws_key.channel)# Wait for new items in the PNL queue.whileTrue:whilenotws_client.empty(ibkr_ws_key):print(ws_client.get(ibkr_ws_key))

SeeLICENSE

IBind is not built, maintained, or endorsed by the Interactive Brokers.

Use at own discretion. IBind and its authors give no guarantee of uninterrupted run of and access to the InteractiveBrokers Client Portal Web API. You should prepare for breaks in connectivity to IBKR servers and should notdepend on continuous uninterrupted connection and functionality. To partially reduce the potential risk use Paper Account credentials.

IBind is provided on an AS IS and AS AVAILABLE basis without any representation or endorsement made and without warrantyof any kind whether express or implied, including but not limited to the implied warranties of satisfactory quality,fitness for a particular purpose, non-infringement, compatibility, security and accuracy. To the extent permitted bylaw, IBind's authors will not be liable for any indirect or consequential loss or damage whatever (including withoutlimitation loss of business, opportunity, data, profits) arising out of or in connection with the use of IBind. IBind'sauthors make no warranty that the functionality of IBind will be uninterrupted or error free, that defects will becorrected or that IBind or the server that makes it available are free of viruses or anything else which may be harmfulor destructive.

IBind has been enriched by incorporating work developed in collaboration withKinetic andGrant Stenger, which now forms part of the initial open-source release. I appreciate their significant contribution to this community-driven initiative. Cheers Kinetic! 🍻

Hi! Thanks for checking out and using this library. If you are interested in discussing your project, requirementorship, consider hiring me, or just wanna chat - I'm happy to talk.

You can email me to get in touch:hello@voyzan.com

Or if you'd just want to give something back, I've got a Buy Me A Coffee account:

Thanks and have an awesome day 👋