| Name | ibind JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | IBind is a REST and WebSocket client library for Interactive Brokers Client Portal Web API. |
| upload_time | 2024-12-02 12:17:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Copyright 2020 Voy Zan Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2020 Voy Zan Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
interactive brokers
rest api
python api
ibkr python api
ibkr web api
ib api
ibkr api
algo trading
algorithmic trading
quant
trading
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
requests
websocket-client
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
*This library is currently being beta-tested. See something that's broken? Did we get something
wrong? [Create an issue and let us know!][issues]*
<p align="center">
<a id="ibind" href="#ibind">
<img src="https://raw.githubusercontent.com/Voyz/ibind/master/media/ibind_logo.png" alt="IBind logo" title="IBind logo" width="600"/>
</a>
</p>
<p align="center">
<a href="https://opensource.org/licenses/Apache-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/>
</a>
<a href="https://github.com/Voyz/ibind/releases">
<img src="https://img.shields.io/pypi/v/ibind?label=version"/>
</a>
</p>
IBind is an unofficial Python API client library for the [Interactive Brokers Client Portal Web API.][ibkr-docs] (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.
_Note: IBind currently supports only the Web API 1.0 since the [newer OAuth-based Web API][web-api] seems to be still in beta and is not fully documented. Once a complete version of the new Web API is released IBind will be extended to support it._
## Installation
```rich
pip install ibind
```
Use [IBeam][ibeam] along with this library for easier authentication with IBKR.
## Documentation
See full [IBind documentation][wiki].
* [Installation][wiki-installation]
* [Basic Concepts][wiki-basic-concepts]
* [IBind Configuration][wiki-ibind-configuration]
* [IbkrClient][wiki-ibkr-client] - REST Python client for [IBKR REST API][ibkr-endpoints].
* [IbkrWsClient][wiki-ibkr-ws-client] - WebSocket Python client for [IBKR WebSocket API][ibkr-websocket].
* [API Reference][api-ibkr-client]
Features:
* REST:
* [Automated question/answer handling][wiki-question-answer]
* [Parallel requests][wiki-parallel-requests]
* [Rate limiting][wiki-rate-limiting]
* [Conid unpacking][wiki-conid-unpacking]
* [and more][wiki-advanced-api]
* WebSocket:
* [WebSocket thread lifecycle handling][wiki-ws-lifecycle]
* [Thread-safe Queue data stream][wiki-ws-queues]
* [Internal subscription tracking][wiki-ws-subscriptions]
* [Health monitoring][wiki-ws-health-monitoring]
* [and more][wiki-advanced-websocket]
<a href="https://www.youtube.com/watch?v=34iHETvbdas">
<img src="https://raw.githubusercontent.com/Voyz/voyz_public/master/ibind_promo_vidA_A01.gif" alt="IBind showcase gif" title="IBind showcase gif" width="500"/>
</a>
## Overview
IBind's core functionality consists of two client classes:
* [`IbkrClient`][ibkr-client-docs] - for [IBKR REST API][ibkr-endpoints]
Using the `IbkrClient` requires constructing it with appropriate arguments, then calling the API methods.
* [`IbkrWsClient`][ibkr-ws-client-docs] - for [IBKR WebSocket API][ibkr-websocket]
Using the `IbkrWsClient` 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 the `IbkrClient` class first.
## Examples
See [all examples][examples].
### Basic REST Example
```python
from ibind import IbkrClient
# Construct the client
client = IbkrClient()
# Call some endpoints
print('\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)
```
### Basic WebSocket Example
```python
from ibind import IbkrWsKey, IbkrWsClient
# Construct the client. Assumes IBIND_ACCOUNT_ID and IBIND_CACERT environment variables have been set.
ws_client = IbkrWsClient(start=True)
# Choose the WebSocket channel
ibkr_ws_key = IbkrWsKey.PNL
# Subscribe to the PNL channel
ws_client.subscribe(channel=ibkr_ws_key.channel)
# Wait for new items in the PNL queue.
while True:
while not ws_client.empty(ibkr_ws_key):
print(ws_client.get(ibkr_ws_key))
```
## Licence
See [LICENSE](https://github.com/Voyz/ibind/blob/master/LICENSE)
## Disclaimer
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 Interactive
Brokers Client Portal Web API. You should prepare for breaks in connectivity to IBKR servers and should not
depend 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 warranty
of 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 by
law, IBind's authors will not be liable for any indirect or consequential loss or damage whatever (including without
limitation loss of business, opportunity, data, profits) arising out of or in connection with the use of IBind. IBind's
authors make no warranty that the functionality of IBind will be uninterrupted or error free, that defects will be
corrected or that IBind or the server that makes it available are free of viruses or anything else which may be harmful
or destructive.
## Acknowledgement
IBind has been enriched by incorporating work developed in collaboration with [Kinetic](https://www.kinetic.xyz/) and [Grant Stenger](https://github.com/GrantStenger), which now forms part of the initial open-source release. I appreciate their significant contribution to this community-driven initiative. Cheers Kinetic! 🍻
## Built by Voy
Hi! Thanks for checking out and using this library. If you are interested in discussing your project, require
mentorship, 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:
<a href="https://www.buymeacoffee.com/voyzan" rel="nofollow">
<img src="https://raw.githubusercontent.com/Voyz/voyz_public/master/vz_BMC.png" alt="Buy Me A Coffee" style="max-width:100%;" width="192">
</a>
Thanks and have an awesome day 👋
[ibeam]: https://github.com/Voyz/ibeam
[examples]: https://github.com/Voyz/ibind/blob/master/examples
[issues]: https://github.com/Voyz/ibind/issues
[api-ibkr-client]: https://github.com/Voyz/ibind/wiki/API-Reference-%E2%80%90-IbkrClient
[ibkr-client-docs]: https://github.com/Voyz/ibind/wiki/Ibkr-Client
[ibkr-ws-client-docs]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client
[ibkr-docs]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/
[ibkr-endpoints]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/#endpoints
[ibkr-websocket]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/#websockets
[web-api]: https://www.interactivebrokers.com/campus/ibkr-api-page/webapi-doc
[wiki]: https://github.com/Voyz/ibind/wiki
[wiki-installation]: https://github.com/Voyz/ibind/wiki/Installation
[wiki-basic-concepts]: https://github.com/Voyz/ibind/wiki/Basic-Concepts
[wiki-ibind-configuration]: https://github.com/Voyz/ibind/wiki/IBind-Configuration
[wiki-ibkr-client]: https://github.com/Voyz/ibind/wiki/Ibkr-Client
[wiki-ibkr-ws-client]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client
[wiki-question-answer]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-place_order
[wiki-parallel-requests]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-marketdata_history_by_symbols
[wiki-rate-limiting]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-marketdata_history_by_symbols
[wiki-conid-unpacking]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-security_stocks_by_symbol
[wiki-advanced-api]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#advanced-api
[wiki-ws-lifecycle]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-managing-the-lifecycle
[wiki-ws-queues]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-consuming-data
[wiki-ws-subscriptions]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-subscribing-and-unsubscribing
[wiki-ws-health-monitoring]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#health-monitoring
[wiki-advanced-websocket]: https://github.com/Voyz/ibind/wiki/Advanced-WebSocket
Raw data
{
"_id": null,
"home_page": null,
"name": "ibind",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "interactive brokers, rest api, python api, ibkr python api, ibkr web api, ib api, ibkr api, algo trading, algorithmic trading, quant, trading",
"author": null,
"author_email": "Voy Zan <voy1982@yahoo.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/2d/6f/85ce8918e256f9553eaf67878870e8560e7293871ddf745a2edafdfedb8f/ibind-0.1.8.tar.gz",
"platform": null,
"description": "*This library is currently being beta-tested. See something that's broken? Did we get something\r\nwrong? [Create an issue and let us know!][issues]*\r\n\r\n\r\n\r\n<p align=\"center\">\r\n <a id=\"ibind\" href=\"#ibind\">\r\n <img src=\"https://raw.githubusercontent.com/Voyz/ibind/master/media/ibind_logo.png\" alt=\"IBind logo\" title=\"IBind logo\" width=\"600\"/>\r\n </a>\r\n</p>\r\n<p align=\"center\">\r\n <a href=\"https://opensource.org/licenses/Apache-2.0\">\r\n <img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\"/>\r\n </a>\r\n <a href=\"https://github.com/Voyz/ibind/releases\">\r\n <img src=\"https://img.shields.io/pypi/v/ibind?label=version\"/> \r\n </a>\r\n</p>\r\n\r\nIBind is an unofficial Python API client library for the [Interactive Brokers Client Portal Web API.][ibkr-docs] (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.\r\n\r\n_Note: IBind currently supports only the Web API 1.0 since the [newer OAuth-based Web API][web-api] seems to be still in beta and is not fully documented. Once a complete version of the new Web API is released IBind will be extended to support it._\r\n\r\n## Installation\r\n\r\n```rich\r\npip install ibind\r\n```\r\n\r\nUse [IBeam][ibeam] along with this library for easier authentication with IBKR.\r\n\r\n## Documentation\r\n\r\nSee full [IBind documentation][wiki].\r\n\r\n* [Installation][wiki-installation]\r\n* [Basic Concepts][wiki-basic-concepts]\r\n* [IBind Configuration][wiki-ibind-configuration]\r\n* [IbkrClient][wiki-ibkr-client] - REST Python client for [IBKR REST API][ibkr-endpoints].\r\n* [IbkrWsClient][wiki-ibkr-ws-client] - WebSocket Python client for [IBKR WebSocket API][ibkr-websocket].\r\n* [API Reference][api-ibkr-client]\r\n\r\nFeatures:\r\n* REST:\r\n * [Automated question/answer handling][wiki-question-answer]\r\n * [Parallel requests][wiki-parallel-requests]\r\n * [Rate limiting][wiki-rate-limiting]\r\n * [Conid unpacking][wiki-conid-unpacking]\r\n * [and more][wiki-advanced-api]\r\n* WebSocket:\r\n * [WebSocket thread lifecycle handling][wiki-ws-lifecycle]\r\n * [Thread-safe Queue data stream][wiki-ws-queues]\r\n * [Internal subscription tracking][wiki-ws-subscriptions]\r\n * [Health monitoring][wiki-ws-health-monitoring]\r\n * [and more][wiki-advanced-websocket]\r\n\r\n<a href=\"https://www.youtube.com/watch?v=34iHETvbdas\">\r\n <img src=\"https://raw.githubusercontent.com/Voyz/voyz_public/master/ibind_promo_vidA_A01.gif\" alt=\"IBind showcase gif\" title=\"IBind showcase gif\" width=\"500\"/>\r\n</a>\r\n\r\n## Overview\r\n\r\nIBind's core functionality consists of two client classes:\r\n\r\n* [`IbkrClient`][ibkr-client-docs] - for [IBKR REST API][ibkr-endpoints]\r\n\r\n Using the `IbkrClient` requires constructing it with appropriate arguments, then calling the API methods.\r\n\r\n* [`IbkrWsClient`][ibkr-ws-client-docs] - for [IBKR WebSocket API][ibkr-websocket]\r\n\r\n Using the `IbkrWsClient` involves handling three areas:\r\n\r\n * 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.\r\n * Subscribing and unsubscribing. It is subscription-based, hence we need to specify which channels we want to subscribe to and remember to unsubscribe later.\r\n * Consuming data. It uses a queue system, hence we need to access these queues and consume their data.\r\n\r\nTheir usage differs substantially. Users are encouraged to familiarise themselves with the `IbkrClient` class first.\r\n\r\n## Examples\r\n\r\nSee [all examples][examples].\r\n\r\n### Basic REST Example\r\n\r\n```python\r\nfrom ibind import IbkrClient\r\n\r\n# Construct the client\r\nclient = IbkrClient()\r\n\r\n# Call some endpoints\r\nprint('\\n#### check_health ####')\r\nprint(client.check_health())\r\n\r\nprint('\\n\\n#### tickle ####')\r\nprint(client.tickle().data)\r\n\r\nprint('\\n\\n#### get_accounts ####')\r\nprint(client.portfolio_accounts().data)\r\n```\r\n\r\n### Basic WebSocket Example\r\n\r\n```python\r\nfrom ibind import IbkrWsKey, IbkrWsClient\r\n\r\n# Construct the client. Assumes IBIND_ACCOUNT_ID and IBIND_CACERT environment variables have been set.\r\nws_client = IbkrWsClient(start=True)\r\n\r\n# Choose the WebSocket channel\r\nibkr_ws_key = IbkrWsKey.PNL\r\n\r\n# Subscribe to the PNL channel\r\nws_client.subscribe(channel=ibkr_ws_key.channel)\r\n\r\n# Wait for new items in the PNL queue.\r\nwhile True:\r\n while not ws_client.empty(ibkr_ws_key):\r\n print(ws_client.get(ibkr_ws_key))\r\n```\r\n\r\n\r\n## Licence\r\n\r\nSee [LICENSE](https://github.com/Voyz/ibind/blob/master/LICENSE)\r\n\r\n## Disclaimer\r\n\r\nIBind is not built, maintained, or endorsed by the Interactive Brokers.\r\n\r\nUse at own discretion. IBind and its authors give no guarantee of uninterrupted run of and access to the Interactive\r\nBrokers Client Portal Web API. You should prepare for breaks in connectivity to IBKR servers and should not\r\ndepend on continuous uninterrupted connection and functionality. To partially reduce the potential risk use Paper Account credentials.\r\n\r\nIBind is provided on an AS IS and AS AVAILABLE basis without any representation or endorsement made and without warranty\r\nof any kind whether express or implied, including but not limited to the implied warranties of satisfactory quality,\r\nfitness for a particular purpose, non-infringement, compatibility, security and accuracy. To the extent permitted by\r\nlaw, IBind's authors will not be liable for any indirect or consequential loss or damage whatever (including without\r\nlimitation loss of business, opportunity, data, profits) arising out of or in connection with the use of IBind. IBind's\r\nauthors make no warranty that the functionality of IBind will be uninterrupted or error free, that defects will be\r\ncorrected or that IBind or the server that makes it available are free of viruses or anything else which may be harmful\r\nor destructive.\r\n\r\n## Acknowledgement\r\n\r\nIBind has been enriched by incorporating work developed in collaboration with [Kinetic](https://www.kinetic.xyz/) and [Grant Stenger](https://github.com/GrantStenger), which now forms part of the initial open-source release. I appreciate their significant contribution to this community-driven initiative. Cheers Kinetic! \ud83c\udf7b\r\n\r\n## Built by Voy\r\n\r\nHi! Thanks for checking out and using this library. If you are interested in discussing your project, require\r\nmentorship, consider hiring me, or just wanna chat - I'm happy to talk.\r\n\r\nYou can email me to get in touch: hello@voyzan.com\r\n\r\nOr if you'd just want to give something back, I've got a Buy Me A Coffee account:\r\n\r\n<a href=\"https://www.buymeacoffee.com/voyzan\" rel=\"nofollow\">\r\n <img src=\"https://raw.githubusercontent.com/Voyz/voyz_public/master/vz_BMC.png\" alt=\"Buy Me A Coffee\" style=\"max-width:100%;\" width=\"192\">\r\n</a>\r\n\r\nThanks and have an awesome day \ud83d\udc4b\r\n\r\n\r\n[ibeam]: https://github.com/Voyz/ibeam\r\n[examples]: https://github.com/Voyz/ibind/blob/master/examples\r\n[issues]: https://github.com/Voyz/ibind/issues\r\n[api-ibkr-client]: https://github.com/Voyz/ibind/wiki/API-Reference-%E2%80%90-IbkrClient\r\n[ibkr-client-docs]: https://github.com/Voyz/ibind/wiki/Ibkr-Client\r\n[ibkr-ws-client-docs]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client\r\n\r\n[ibkr-docs]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/\r\n[ibkr-endpoints]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/#endpoints\r\n[ibkr-websocket]: https://ibkrcampus.com/ibkr-api-page/cpapi-v1/#websockets\r\n[web-api]: https://www.interactivebrokers.com/campus/ibkr-api-page/webapi-doc\r\n\r\n\r\n[wiki]: https://github.com/Voyz/ibind/wiki\r\n[wiki-installation]: https://github.com/Voyz/ibind/wiki/Installation\r\n[wiki-basic-concepts]: https://github.com/Voyz/ibind/wiki/Basic-Concepts\r\n[wiki-ibind-configuration]: https://github.com/Voyz/ibind/wiki/IBind-Configuration\r\n[wiki-ibkr-client]: https://github.com/Voyz/ibind/wiki/Ibkr-Client\r\n[wiki-ibkr-ws-client]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client\r\n\r\n[wiki-question-answer]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-place_order\r\n[wiki-parallel-requests]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-marketdata_history_by_symbols\r\n[wiki-rate-limiting]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-marketdata_history_by_symbols\r\n[wiki-conid-unpacking]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#-security_stocks_by_symbol\r\n[wiki-advanced-api]: https://github.com/Voyz/ibind/wiki/Ibkr-Client#advanced-api\r\n\r\n[wiki-ws-lifecycle]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-managing-the-lifecycle\r\n[wiki-ws-queues]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-consuming-data\r\n[wiki-ws-subscriptions]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#-subscribing-and-unsubscribing\r\n[wiki-ws-health-monitoring]: https://github.com/Voyz/ibind/wiki/Ibkr-Ws-Client#health-monitoring\r\n[wiki-advanced-websocket]: https://github.com/Voyz/ibind/wiki/Advanced-WebSocket\r\n",
"bugtrack_url": null,
"license": "Copyright 2020 Voy Zan Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright 2020 Voy Zan Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "IBind is a REST and WebSocket client library for Interactive Brokers Client Portal Web API.",
"version": "0.1.8",
"project_urls": {
"Homepage": "https://github.com/Voyz/ibind"
},
"split_keywords": [
"interactive brokers",
" rest api",
" python api",
" ibkr python api",
" ibkr web api",
" ib api",
" ibkr api",
" algo trading",
" algorithmic trading",
" quant",
" trading"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d6f85ce8918e256f9553eaf67878870e8560e7293871ddf745a2edafdfedb8f",
"md5": "37a0b5da63d3d8995308a7390e1c4760",
"sha256": "aae7467199aa7d76f128fc2b56831334e82bd9178aae6ccec8aaa7837b4dc9a5"
},
"downloads": -1,
"filename": "ibind-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "37a0b5da63d3d8995308a7390e1c4760",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 86916,
"upload_time": "2024-12-02T12:17:47",
"upload_time_iso_8601": "2024-12-02T12:17:47.097481Z",
"url": "https://files.pythonhosted.org/packages/2d/6f/85ce8918e256f9553eaf67878870e8560e7293871ddf745a2edafdfedb8f/ibind-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 12:17:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Voyz",
"github_project": "ibind",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "requests",
"specs": [
[
"==",
"2.31.*"
]
]
},
{
"name": "websocket-client",
"specs": [
[
"==",
"1.7.*"
]
]
}
],
"lcname": "ibind"
}
