qx-ibbridge 1.0.0__tar.gz

qx_ibbridge-1.0.0/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Alpha Technologies
+
+                                 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 2026 Alpha Technologies
+
+   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.

qx_ibbridge-1.0.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: qx_ibbridge
+Version: 1.0.0
+Summary: Drop-in FastAPI + SDK bridge for ib_async and ib_insync-style Interactive Brokers workflows
+Author-email: Alpha Quant Capital <vignesh@alphaquantcapital.com>
+Project-URL: Homepage, https://superinvestor.io
+Project-URL: Documentation, https://superinvestor.io
+Project-URL: Company, https://fund.alpha-techlab.com
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi>=0.100
+Requires-Dist: uvicorn[standard]>=0.23
+Requires-Dist: ib_async>=2.1
+Requires-Dist: websockets>=11
+Requires-Dist: requests>=2.31
+Requires-Dist: websocket-client>=1.7
+Provides-Extra: desktop
+Requires-Dist: customtkinter>=5.2; extra == "desktop"
+Requires-Dist: pillow; extra == "desktop"
+Requires-Dist: pyinstaller>=6.0; extra == "desktop"
+Dynamic: license-file
+
+<p align="center">
+  <img src="assets/app-logo.png" width="72" height="72" alt="QX-IB Bridge Server">
+</p>
+
+<h1 align="center">QuantX-IB Bridge Server</h1>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+  <img src="https://img.shields.io/badge/framework-FastAPI-009688" alt="FastAPI">
+  <img src="https://img.shields.io/badge/protocol-WebSocket%20%2B%20HTTP-6B46C1" alt="WebSocket + HTTP">
+  <img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License">
+</p>
+
+<p align="center">
+  One IB connection. Every script shares it. Zero <code>clientId</code> collisions.
+</p>
+
+---
+
+`QX-IB Bridge Server` is a **thin multiplexer** for traders already using
+`ib_async`, `ib_insync`, or direct IB Gateway/TWS scripts who have hit the
+same scaling wall: too many strategies, too many direct broker connections,
+and too many `clientId` conflicts. It is a FastAPI + SDK wrapper around
+`ib_async`, not a reimplementation of the IB stack, so the wire protocol,
+order state machines, and ticker logic still come from the real
+`ib_async.IB`.
+
+Instead of opening many separate broker API sessions, the bridge keeps one
+managed IB connection alive and lets the rest of your scripts share it through
+a local HTTP/WebSocket layer. In practice, that means one real IB connection,
+many strategies, and a near-drop-in migration path.
+
+> This is not a replacement for the Interactive Brokers Python ecosystem. It is an **operational
+> upgrade** for people already in it.
+
+## Why it exists
+
+| Without a bridge                                                     | With QuantX-IB Bridge                             |
+| -------------------------------------------------------------------- | ------------------------------------------------- |
+| Every script connects directly to IB Gateway/TWS                     | One bridge process owns the real IB connection    |
+| Every script consumes an API client slot                             | Many scripts share a single connection            |
+| `clientId` collisions and contention                               | No collisions — bridge manages the single client |
+| Scaling means connection juggling and manual `clientId` discipline | Scaling stays inside one shared bridge            |
+
+## Architecture at a glance
+
+```
+┌─────────────┐   ┌─────────────┐   ┌─────────────┐
+│  Strategy 1 │   │  Strategy 2 │   │  Strategy N │
+│  (SDK)      │   │  (SDK)      │   │  (SDK)      │
+└──────┬──────┘   └──────┬──────┘   └──────┬──────┘
+       │ HTTP/WS         │ HTTP/WS         │ HTTP/WS
+       └─────────────────┼─────────────────┘
+                         ▼
+              ┌─────────────────────┐
+              │  QX-IB Bridge       │
+              │  FastAPI Server     │
+              │  (single process)   │
+              └──────────┬──────────┘
+                         │ ib_async.IB
+                         ▼
+              ┌─────────────────────┐
+              │  IB Gateway / TWS   │
+              │  (1 connection)     │
+              └─────────────────────┘
+```
+
+**What ib_async does** (you don't touch): wire protocol, serialization, order
+state machines, ticker price aggregation, event loop management.
+
+**What the bridge does**: keeps one managed IB session open, exposes it over a
+local FastAPI + WebSocket server, and gives existing IB Python code a much
+cleaner way to scale.
+
+## What you keep
+
+- Familiar `IB()` / `connect()` / `disconnect()` usage
+- Familiar request patterns like `reqHistoricalData()`, `placeOrder()`, `positions()`
+- Your existing Python scripts and strategy layout
+
+## What changes
+
+- One import line: `from qx_ibbridge import *`
+- Your scripts point at the local bridge instead of the raw broker socket
+
+## Quick start
+
+Install the package:
+
+```bash
+pip install qx_ibbridge
+```
+
+Start the IB Gateway:
+
+1. Download the latest IB Gateway from [Interactive Brokers](https://www.interactivebrokers.com/en/trading/ibgateway-latest.php)
+2. Install and launch IB Gateway
+3. Log in with your Interactive Brokers credentials
+4. Ensure it listens on `localhost:4004` (default)
+
+Start the bridge:
+
+```bash
+qx-server --ib-host localhost --ib-port 4004 --host 127.0.0.1 --port 4002
+```
+
+Default local model:
+
+- external IB Gateway/TWS API socket: `localhost:4004`
+- local QuantX bridge server: `localhost:4002`
+
+## Drop-in SDK workflow
+
+The same `pip install qx_ibbridge` package gives you both:
+
+- the `qx-server` CLI for running the bridge server
+- the `qx_ibbridge` import for drop-in strategy scripts
+
+Then change your script from:
+
+```python
+from ib_async import *
+# or
+from ib_insync import *
+```
+
+to:
+
+```python
+from qx_ibbridge import *
+```
+
+and keep the same shape:
+
+```python
+ib = IB()
+ib.connect(host="localhost", port=4002)
+print(ib.managedAccounts())
+```
+
+The SDK defaults to the local bridge at `localhost:4002`.
+
+For `ib_async` users, this is the intended drop-in path. For `ib_insync`
+users, the workflow is the same in spirit: keep your IB-style code, but route
+it through one local bridge instead of many direct broker sessions.
+
+## Use it your way
+
+### 1. Python
+
+```bash
+qx-server --ib-host localhost --ib-port 4004 --host 127.0.0.1 --port 4002
+```
+
+### 2. Desktop app
+
+<p align="center">
+  <img src="assets/server-app-screenshot.png" width="500" alt="QuantX IB Bridge Server Desktop App">
+</p>
+
+Download the latest desktop app from
+[GitHub Releases](https://github.com/KVignesh122/qx-ib-bridge/releases).
+
+If you prefer to launch the desktop UI from Python instead of downloading the
+packaged app:
+
+```bash
+pip install "qx_ibbridge[desktop]"
+qx-ib-bridge-server-desktop
+```
+
+The desktop app is optional. It is only a launcher for the same bridge server,
+for users who prefer clicking a UI over running `qx-server`. It does not bundle
+IB Gateway, and it does not change the underlying bridge or SDK behavior. The
+core product already works through `pip install qx_ibbridge`; the desktop app
+is only an add-on for server-launch convenience.
+
+## Examples
+
+- [sample.py](sample.py): direct `ib_async` example against raw IB Gateway/TWS
+- [sample_copy.py](sample_copy.py): bridge example using `qx_ibbridge`
+
+## Project layout
+
+| Directory                | Purpose                               |
+| ------------------------ | ------------------------------------- |
+| `server/`              | Canonical FastAPI implementation      |
+| `ib_bridge_server/`    | Generic Python server package and CLI |
+| `qx_ibbridge/`         | Drop-in SDK package                   |
+| `qx_ib_bridge_server/` | Desktop launcher                      |
+
+## Behind this repo
+
+<p align="center">
+  <img src="assets/quantx-logo-text.png" height="48" alt="QuantX" style="margin-right: 32px">
+  <img src="assets/alpha-logo.png" height="48" alt="Alpha Technologies">
+</p>
+
+QX-IB Bridge Server is open-sourced by **Alpha Technologies**.
+
+Across the broader ecosystem, the team builds investor education, quant
+research, and operating workflows around systematic, data-driven trading.
+
+- [superinvestor.io](https://superinvestor.io) and [alpha-techlab.com](https://alpha-techlab.com) — QuantX hands-on learning, guided
+  challenges, live market sessions, and practical quant-investing courses
+- [fund.alpha-techlab.com](https://fund.alpha-techlab.com) — Regulated fund management and investors entry
+  point
+
+## Acknowledgements
+
+This project stands on the work of two open-source efforts:
+
+- **[ib_async](https://github.com/ib-api-reloaded/ib_async)** — the actively maintained IB API library that this bridge wraps. The bridge server delegates all wire-protocol, order state machine, and ticker logic to `ib_async.IB`, and the SDK re-exports its contract and order types so existing scripts keep working without change.
+
+- **[ib_insync](https://github.com/erdewit/ib_insync)** by Ewald de Wit — the original Python IB API library whose elegant synchronous-style API design this SDK is compatible with. `ib_async` is itself a maintained fork of `ib_insync`.
+
+## Disclaimer
+
+This software is provided "as is" without warranty of any kind. It is not
+financial advice, a solicitation to trade, or a guarantee of profitability.
+You are solely responsible for any trades placed using this software. The
+authors and contributors are not liable for any financial losses incurred.
+
+## Notes
+
+- Not affiliated with Interactive Brokers
+- IB Gateway/TWS remains external and user-managed
+- This bridge solves `clientId` contention but does not remove IB pacing,
+  market data, or broker-side account limits
+- Released under the Apache License 2.0; see [LICENSE](LICENSE)
+- Never commit IB credentials to this repository
+
+See also:
+
+- [CHANGELOG.md](CHANGELOG.md)
+- [CONTRIBUTING.md](CONTRIBUTING.md)
+- [SECURITY.md](SECURITY.md)