ibind 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
ibind-0.0.1/LICENSE ADDED
@@ -0,0 +1,203 @@
1
+ Copyright 2020 Voy Zan
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright 2020 Voy Zan
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
ibind-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,192 @@
1
+ Metadata-Version: 2.1
2
+ Name: ibind
3
+ Version: 0.0.1
4
+ Summary: IBind is a REST and WebSocket client library for Interactive Brokers Client Portal Web API.
5
+ Home-page: https://github.com/Voyz/ibind
6
+ Author: Voy Zan
7
+ Author-email: voy1982@yahoo.co.uk
8
+ License: Apache-2.0
9
+ Keywords: interactive brokers,rest api,python api,ibkr python api,ibkr web api,ib api,ibkr api,algo trading,algorithmic trading,quant,trading
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Description-Content-Type: text/markdown
15
+ License-File: LICENSE
16
+ Requires-Dist: requests==2.31.*
17
+ Requires-Dist: websocket-client==1.7.*
18
+
19
+ *This library is currently being developed. See something that's broken? Did we get something
20
+ wrong? [Create an issue and let us know!][issues]*
21
+
22
+ # IBind
23
+
24
+ IBind is a REST and WebSocket client library for [Interactive Brokers Client Portal Web API.][gateway]
25
+
26
+ I recommend using this library along with [IBeam][ibeam] for easier authentication with IBKR.
27
+
28
+ ## NOTICE
29
+ ### This library is a work in progres. I haven't published it yet. Many things are due to change without any notice.
30
+
31
+ Features:
32
+
33
+ * **REST Python client** - for IBKR REST API.
34
+ * **WebSocket Python client** - for IBKR WebSocket API.
35
+ * **Feature rich REST** - automated question/answer handling, parallel requests, rate limiting, conid unpacking, and more.
36
+ * **Feature rich WebSocket** - WebSocket thread lifecycle handling, thread-safe Queue data stream, internal subscription tracking, heartbeat monitoring, and more.
37
+
38
+
39
+ ## Examples
40
+
41
+ See [all examples][examples]
42
+
43
+ ### 01 IbkrClient basic
44
+
45
+ ```python
46
+ import warnings
47
+
48
+ from ibind import IbkrClient
49
+
50
+ warnings.filterwarnings("ignore", message="Unverified HTTPS request is being made to host 'localhost'")
51
+
52
+ c = IbkrClient(url='https://localhost:5000/v1/api/')
53
+
54
+ print('\n#### check_health ####')
55
+ print(c.check_health())
56
+
57
+ print('\n\n#### tickle ####')
58
+ print(c.tickle().data)
59
+
60
+ print('\n\n#### get_accounts ####')
61
+ print(c.get_accounts().data)
62
+ ```
63
+
64
+ ### 02 IbkrClient intermediate
65
+ ```python
66
+ import var
67
+
68
+ from ibind import IbkrClient
69
+ import ibind
70
+
71
+ ibind.logs.initialize()
72
+
73
+ c = IbkrClient(
74
+ url='https://localhost:5000/v1/api/',
75
+ cacert=var.IBKR_CACERT,
76
+ )
77
+
78
+ print('\n#### get_accounts ####')
79
+ accounts = c.get_accounts().data
80
+ c.account_id = accounts[0]['accountId']
81
+ print(accounts)
82
+
83
+ print('\n\n#### get_ledger ####')
84
+ ledger = c.get_ledger().data
85
+ for currency, subledger in ledger.items():
86
+ print(f'\t Ledger currency: {currency}')
87
+ print(f'\t cash balance: {subledger["cashbalance"]}')
88
+ print(f'\t net liquidation value: {subledger["netliquidationvalue"]}')
89
+ print(f'\t stock market value: {subledger["stockmarketvalue"]}')
90
+ print()
91
+
92
+ print('\n#### get_positions ####')
93
+ positions = c.get_positions().data
94
+ for position in positions:
95
+ print(f'\t Position {position["ticker"]}: {position["position"]} (${position["mktValue"]})')
96
+ ```
97
+
98
+ ### IbkrWsClient basic
99
+
100
+ ```python
101
+ import os
102
+ import time
103
+
104
+ import ibind
105
+ from ibind.client.ibkr_definitions import snapshot_keys_to_ids
106
+ from ibind import IbkrWsKey, IbkrClient, IbkrWsClient
107
+
108
+ ibind.logs.initialize(log_to_file=False)
109
+
110
+ account_id = os.getenv('IBKR_ACCOUNT_ID', '[YOUR_ACCOUNT_ID]')
111
+
112
+ client = IbkrClient(
113
+ account_id=account_id,
114
+ url='https://localhost:5000/v1/api/',
115
+ )
116
+
117
+ ws_client = IbkrWsClient(
118
+ ibkr_client=client,
119
+ account_id=account_id,
120
+ url='wss://localhost:5000/v1/api/ws'
121
+ )
122
+
123
+ ws_client.start()
124
+ channel = 'md+265598'
125
+ fields = [str(x) for x in snapshot_keys_to_ids(['symbol', 'open', 'high', 'low', 'close', 'volume',])]
126
+
127
+ qa = ws_client.new_queue_accessor(IbkrWsKey.MARKET_DATA)
128
+
129
+ ws_client.subscribe(channel, {'fields': fields}, needs_confirmation=False)
130
+
131
+ while ws_client.running:
132
+ try:
133
+ while not qa.empty():
134
+ print(str(qa), qa.get())
135
+
136
+ time.sleep(1)
137
+ except KeyboardInterrupt:
138
+ print('KeyboardInterrupt')
139
+ break
140
+
141
+ ws_client.unsubscribe(channel, {'fields': fields}, needs_confirmation=False)
142
+
143
+ ws_client.shutdown()
144
+ ```
145
+
146
+
147
+ ## Licence
148
+
149
+ See [LICENSE](https://github.com/Voyz/ibind/blob/master/LICENSE)
150
+
151
+ ## Disclaimer
152
+
153
+ IBind is not built, maintained, or endorsed by the Interactive Brokers.
154
+
155
+ Use at own discretion. IBind and its authors give no guarantee of uninterrupted run of and access to the Interactive
156
+ Brokers Client Portal Web API. You should prepare for breaks in connectivity to IBKR servers and should not
157
+ depend on continuous uninterrupted connection and functionality. To partially reduce the potential risk use Paper Account credentials.
158
+
159
+ IBind is provided on an AS IS and AS AVAILABLE basis without any representation or endorsement made and without warranty
160
+ of any kind whether express or implied, including but not limited to the implied warranties of satisfactory quality,
161
+ fitness for a particular purpose, non-infringement, compatibility, security and accuracy. To the extent permitted by
162
+ law, IBind's authors will not be liable for any indirect or consequential loss or damage whatever (including without
163
+ limitation loss of business, opportunity, data, profits) arising out of or in connection with the use of IBind. IBind's
164
+ authors make no warranty that the functionality of IBind will be uninterrupted or error free, that defects will be
165
+ corrected or that IBind or the server that makes it available are free of viruses or anything else which may be harmful
166
+ or destructive.
167
+
168
+ ## Acknowledgement
169
+
170
+ IBind has been enriched by incorporating work developed in collaboration with [Kinetic](https://www.kinetic.xyz/), which now forms part of this open-source release. I appreciate Kinetic's significant contribution to this community-driven initiative. Cheers Kinetic! 🍻
171
+
172
+ ## Built by Voy
173
+
174
+ Hi! Thanks for checking out and using this library. If you are interested in discussing your project, require
175
+ mentorship, consider hiring me, or just wanna chat - I'm happy to talk.
176
+
177
+ You can email me to get in touch: hello@voyzan.com
178
+
179
+ Or if you'd just want to give something back, I've got a Buy Me A Coffee account:
180
+
181
+ <a href="https://www.buymeacoffee.com/voyzan" rel="nofollow">
182
+ <img src="https://raw.githubusercontent.com/Voyz/voyz_public/master/vz_BMC.png" alt="Buy Me A Coffee" style="max-width:100%;" width="192">
183
+ </a>
184
+
185
+ Thanks and have an awesome day 👋
186
+
187
+
188
+ [ibeam]: https://github.com/Voyz/ibeam
189
+ [examples]: https://github.com/Voyz/ibind/blob/master/examples
190
+ [issues]: https://github.com/Voyz/ibind/issues
191
+
192
+ [gateway]: https://ibkrcampus.com/ibkr-api-page/webapi-doc/
ibind-0.0.1/README.md ADDED
@@ -0,0 +1,174 @@
1
+ *This library is currently being developed. See something that's broken? Did we get something
2
+ wrong? [Create an issue and let us know!][issues]*
3
+
4
+ # IBind
5
+
6
+ IBind is a REST and WebSocket client library for [Interactive Brokers Client Portal Web API.][gateway]
7
+
8
+ I recommend using this library along with [IBeam][ibeam] for easier authentication with IBKR.
9
+
10
+ ## NOTICE
11
+ ### This library is a work in progres. I haven't published it yet. Many things are due to change without any notice.
12
+
13
+ Features:
14
+
15
+ * **REST Python client** - for IBKR REST API.
16
+ * **WebSocket Python client** - for IBKR WebSocket API.
17
+ * **Feature rich REST** - automated question/answer handling, parallel requests, rate limiting, conid unpacking, and more.
18
+ * **Feature rich WebSocket** - WebSocket thread lifecycle handling, thread-safe Queue data stream, internal subscription tracking, heartbeat monitoring, and more.
19
+
20
+
21
+ ## Examples
22
+
23
+ See [all examples][examples]
24
+
25
+ ### 01 IbkrClient basic
26
+
27
+ ```python
28
+ import warnings
29
+
30
+ from ibind import IbkrClient
31
+
32
+ warnings.filterwarnings("ignore", message="Unverified HTTPS request is being made to host 'localhost'")
33
+
34
+ c = IbkrClient(url='https://localhost:5000/v1/api/')
35
+
36
+ print('\n#### check_health ####')
37
+ print(c.check_health())
38
+
39
+ print('\n\n#### tickle ####')
40
+ print(c.tickle().data)
41
+
42
+ print('\n\n#### get_accounts ####')
43
+ print(c.get_accounts().data)
44
+ ```
45
+
46
+ ### 02 IbkrClient intermediate
47
+ ```python
48
+ import var
49
+
50
+ from ibind import IbkrClient
51
+ import ibind
52
+
53
+ ibind.logs.initialize()
54
+
55
+ c = IbkrClient(
56
+ url='https://localhost:5000/v1/api/',
57
+ cacert=var.IBKR_CACERT,
58
+ )
59
+
60
+ print('\n#### get_accounts ####')
61
+ accounts = c.get_accounts().data
62
+ c.account_id = accounts[0]['accountId']
63
+ print(accounts)
64
+
65
+ print('\n\n#### get_ledger ####')
66
+ ledger = c.get_ledger().data
67
+ for currency, subledger in ledger.items():
68
+ print(f'\t Ledger currency: {currency}')
69
+ print(f'\t cash balance: {subledger["cashbalance"]}')
70
+ print(f'\t net liquidation value: {subledger["netliquidationvalue"]}')
71
+ print(f'\t stock market value: {subledger["stockmarketvalue"]}')
72
+ print()
73
+
74
+ print('\n#### get_positions ####')
75
+ positions = c.get_positions().data
76
+ for position in positions:
77
+ print(f'\t Position {position["ticker"]}: {position["position"]} (${position["mktValue"]})')
78
+ ```
79
+
80
+ ### IbkrWsClient basic
81
+
82
+ ```python
83
+ import os
84
+ import time
85
+
86
+ import ibind
87
+ from ibind.client.ibkr_definitions import snapshot_keys_to_ids
88
+ from ibind import IbkrWsKey, IbkrClient, IbkrWsClient
89
+
90
+ ibind.logs.initialize(log_to_file=False)
91
+
92
+ account_id = os.getenv('IBKR_ACCOUNT_ID', '[YOUR_ACCOUNT_ID]')
93
+
94
+ client = IbkrClient(
95
+ account_id=account_id,
96
+ url='https://localhost:5000/v1/api/',
97
+ )
98
+
99
+ ws_client = IbkrWsClient(
100
+ ibkr_client=client,
101
+ account_id=account_id,
102
+ url='wss://localhost:5000/v1/api/ws'
103
+ )
104
+
105
+ ws_client.start()
106
+ channel = 'md+265598'
107
+ fields = [str(x) for x in snapshot_keys_to_ids(['symbol', 'open', 'high', 'low', 'close', 'volume',])]
108
+
109
+ qa = ws_client.new_queue_accessor(IbkrWsKey.MARKET_DATA)
110
+
111
+ ws_client.subscribe(channel, {'fields': fields}, needs_confirmation=False)
112
+
113
+ while ws_client.running:
114
+ try:
115
+ while not qa.empty():
116
+ print(str(qa), qa.get())
117
+
118
+ time.sleep(1)
119
+ except KeyboardInterrupt:
120
+ print('KeyboardInterrupt')
121
+ break
122
+
123
+ ws_client.unsubscribe(channel, {'fields': fields}, needs_confirmation=False)
124
+
125
+ ws_client.shutdown()
126
+ ```
127
+
128
+
129
+ ## Licence
130
+
131
+ See [LICENSE](https://github.com/Voyz/ibind/blob/master/LICENSE)
132
+
133
+ ## Disclaimer
134
+
135
+ IBind is not built, maintained, or endorsed by the Interactive Brokers.
136
+
137
+ Use at own discretion. IBind and its authors give no guarantee of uninterrupted run of and access to the Interactive
138
+ Brokers Client Portal Web API. You should prepare for breaks in connectivity to IBKR servers and should not
139
+ depend on continuous uninterrupted connection and functionality. To partially reduce the potential risk use Paper Account credentials.
140
+
141
+ IBind is provided on an AS IS and AS AVAILABLE basis without any representation or endorsement made and without warranty
142
+ of any kind whether express or implied, including but not limited to the implied warranties of satisfactory quality,
143
+ fitness for a particular purpose, non-infringement, compatibility, security and accuracy. To the extent permitted by
144
+ law, IBind's authors will not be liable for any indirect or consequential loss or damage whatever (including without
145
+ limitation loss of business, opportunity, data, profits) arising out of or in connection with the use of IBind. IBind's
146
+ authors make no warranty that the functionality of IBind will be uninterrupted or error free, that defects will be
147
+ corrected or that IBind or the server that makes it available are free of viruses or anything else which may be harmful
148
+ or destructive.
149
+
150
+ ## Acknowledgement
151
+
152
+ IBind has been enriched by incorporating work developed in collaboration with [Kinetic](https://www.kinetic.xyz/), which now forms part of this open-source release. I appreciate Kinetic's significant contribution to this community-driven initiative. Cheers Kinetic! 🍻
153
+
154
+ ## Built by Voy
155
+
156
+ Hi! Thanks for checking out and using this library. If you are interested in discussing your project, require
157
+ mentorship, consider hiring me, or just wanna chat - I'm happy to talk.
158
+
159
+ You can email me to get in touch: hello@voyzan.com
160
+
161
+ Or if you'd just want to give something back, I've got a Buy Me A Coffee account:
162
+
163
+ <a href="https://www.buymeacoffee.com/voyzan" rel="nofollow">
164
+ <img src="https://raw.githubusercontent.com/Voyz/voyz_public/master/vz_BMC.png" alt="Buy Me A Coffee" style="max-width:100%;" width="192">
165
+ </a>
166
+
167
+ Thanks and have an awesome day 👋
168
+
169
+
170
+ [ibeam]: https://github.com/Voyz/ibeam
171
+ [examples]: https://github.com/Voyz/ibind/blob/master/examples
172
+ [issues]: https://github.com/Voyz/ibind/issues
173
+
174
+ [gateway]: https://ibkrcampus.com/ibkr-api-page/webapi-doc/
@@ -0,0 +1,7 @@
1
+ import ibind.support.logs as logs
2
+ from ibind.client.ibkr_client import IbkrClient
3
+ from ibind.client.ibkr_ws_client import IbkrWsClient
4
+ from ibind.client.ibkr_ws_client import IbkrWsKey
5
+ from ibind.client.ibkr_ws_client import IbkrSubscriptionProcessor
6
+
7
+ __version__ = "0.0.1"
@@ -0,0 +1,57 @@
1
+ import os
2
+ import tempfile
3
+ from distutils.util import strtobool
4
+
5
+
6
+ def to_bool(value):
7
+ return bool(strtobool(str(value)))
8
+
9
+
10
+ ##### LOGS #####
11
+
12
+ LOG_TO_CONSOLE = to_bool(os.environ.get('IBIND_LOG_TO_CONSOLE', True))
13
+ """Whether logs should be streamed to the standard output."""
14
+
15
+ LOG_LEVEL = os.getenv('IBIND_LOG_LEVEL', 'DEBUG')
16
+ """ The global log level for the StreamHandler. """
17
+
18
+ LOG_FORMAT = os.getenv('IBIND_LOG_FORMAT', '%(asctime)s|%(levelname)-.1s| %(message)s')
19
+ """ Log format that is used by IBind """
20
+
21
+ LOGS_DIR = os.getenv('IBIND_LOGS_DIR', tempfile.gettempdir())
22
+ """ Directory of file logs produced. """
23
+
24
+ LOG_TO_FILE = to_bool(os.environ.get('IBIND_LOG_TO_FILE', True))
25
+ """Whether logs should be saved to a file."""
26
+
27
+ ##### IBKR #####
28
+
29
+ IBKR_URL = os.getenv('IBKR_URL', None)
30
+ """ IBKR Client Portal Gateway's URL for REST API."""
31
+
32
+ IBKR_WS_URL = os.getenv('IBKR_WS_URL', None)
33
+ """ IBKR Client Portal Gateway's URL for WebSocket API."""
34
+
35
+ IBKR_ACCOUNT_ID = os.getenv('IBKR_ACCOUNT_ID', None)
36
+ """ IBKR account ID to use."""
37
+
38
+ IBKR_CACERT = os.getenv('IBKR_CACERT', False)
39
+ """ Path to certificates used to communicate with IBKR Client Portal Gateway."""
40
+
41
+ IBKR_WS_PING_INTERVAL = int(os.getenv('IBKR_WS_PING_INTERVAL', 45))
42
+ """ Interval between WebSocket pings. """
43
+
44
+ IBKR_WS_MAX_PING_INTERVAL = int(os.getenv('IBKR_WS_MAX_PING_INTERVAL', 300))
45
+ """ Max accepted interval between WebSocket pings. """
46
+
47
+ IBKR_WS_TIMEOUT = int(os.getenv('IBKR_WS_TIMEOUT', 5))
48
+ """ Timeout for WebSocket state change verifications. """
49
+
50
+ IBKR_WS_SUBSCRIPTION_RETRIES = int(os.getenv('IBKR_WS_SUBSCRIPTION_RETRIES', 5))
51
+ """ Number of attempts to create a WebSocket subscription. """
52
+
53
+ IBKR_WS_SUBSCRIPTION_TIMEOUT = int(os.getenv('IBKR_WS_SUBSCRIPTION_TIMEOUT', 2))
54
+ """ Timeout for WebSocket subscription verifications. """
55
+
56
+ IBKR_WS_LOG_RAW_MESSAGES = to_bool(os.environ.get('IBKR_WS_LOG_RAW_MESSAGES', False))
57
+ """Whether raw WebSocket messages should be logged."""