moomoo-api-mcp 0.1.6__py3-none-any.whl

moomoo_api_mcp-0.1.6.dist-info/METADATA

@@ -0,0 +1,457 @@
+Metadata-Version: 2.4
+Name: moomoo-api-mcp
+Version: 0.1.6
+Summary: Moomoo API MCP Server
+Project-URL: Repository, https://github.com/Litash/moomoo-api-mcp
+Project-URL: Issues, https://github.com/Litash/moomoo-api-mcp/issues
+Author-email: Yichen Lu <yichen.lu529@gamil.com>
+License:                                  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 [yyyy] [name of copyright owner]
+        
+           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.
+License-File: LICENSE
+Keywords: ai,finance,mcp,moomoo,trading
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Requires-Python: >=3.10
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: moomoo-api>=3.3.0
+Requires-Dist: pandas>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Moomoo API MCP Server
+
+An MCP (Model Context Protocol) server for the Moomoo trading platform. This server allows AI agents (like Claude Desktop or Gemini) to access market data, account information, and execute trades via the moomoo-api Python SDK.
+
+## Features
+
+- **Market Data**: Real-time quotes, historical K-lines, market snapshots, and order books.
+- **Account Management**: Comprehensive account summaries, assets, positions, and cash flow analysis.
+- **Trading**: Full order management including placing, modifying, and canceling orders.
+- **System Health**: Built-in health checks and connectivity verification.
+- **Extensible Architecture**: Built on FastMCP for easy extension of trading capabilities.
+
+## Tools
+
+### System
+
+- `check_health`: Check connectivity to Moomoo OpenD gateway and server health.
+
+### Account
+
+- `get_accounts`: List all trading accounts (REAL and SIMULATE).
+- `get_account_summary`: Get a complete summary of assets and positions for an account.
+- `get_assets`: Retrieve account assets (cash, market value, buying power).
+- `get_positions`: Get current stock positions with P/L data.
+- `get_max_tradable`: Calculate maximum tradable quantity for a specific stock.
+- `get_margin_ratio`: Check margin ratios for specific stocks.
+- `get_cash_flow`: Retrieve historical cash flow records.
+- `unlock_trade`: Unlock trading access for REAL accounts.
+
+### Market Data
+
+- `get_stock_quote`: Get real-time stock quotes.
+- `get_historical_klines`: Retrieve historical candlestick data (Day, Week, Min, etc.).
+- `get_market_snapshot`: Get efficient market snapshots for multiple stocks.
+- `get_order_book`: View real-time bid/ask order book depth.
+
+### Trading
+
+- `place_order`: Place a new order (Market, Limit, Stop, etc.).
+- `modify_order`: Modify price or quantity of an open order.
+- `cancel_order`: Cancel an open order.
+- `get_orders`: Get list of orders for the current day.
+- `get_deals`: Get list of executed trades (deals) for the current day.
+- `get_history_orders`: Search historical orders.
+- `get_history_deals`: Search historical deals.
+
+## Installation
+
+### Quick Start (Recommended)
+
+You can run the server directly using `uvx` (part of the [uv](https://github.com/astral-sh/uv) toolkit).
+Using `--refresh` ensures you are always running the latest version:
+
+```bash
+uvx --refresh moomoo-api-mcp
+```
+
+### Permanent Installation
+
+To install it as a persistent tool available in your shell:
+
+```bash
+uv tool install moomoo-api-mcp
+# Then run:
+moomoo-api-mcp
+```
+
+> **Note**: The `moomoo-api` Python SDK and other dependencies will be installed automatically.
+
+### Development Setup
+
+1. **Clone the repository**:
+
+   ```bash
+   git clone https://github.com/Litash/moomoo-api-mcp.git
+   cd moomoo-api-mcp
+   ```
+
+2. **Install dependencies**:
+
+   ```bash
+   uv sync
+   ```
+
+3. **Run locally**:
+   ```bash
+   uv run moomoo-api-mcp
+   ```
+
+---
+
+## Configuration
+
+### 1. Prerequisites
+
+#### Moomoo OpenD (Required)
+
+The MCP server communicates with the Moomoo API via **Moomoo OpenD**, a local gateway application. You **MUST** install and run this first.
+
+1. **Download OpenD**:
+   - Visit the [Moomoo Open API Download Page](https://www.moomoo.com/download/opend).
+   - Download the version appropriate for your OS (Windows/Mac/Linux).
+
+2. **Install & Run**:
+   - Install the application.
+   - Launch **Moomoo OpenD**.
+   - Log in with your Moomoo account credentials.
+
+3. **Configure**:
+   - Ensure the listening port is set to `11111` (this is the default).
+   - **Note**: The MCP server connects to `127.0.0.1:11111` by default.
+
+### 2. Environment Variables
+
+To enable **REAL account** access, you must securely provide your credentials.
+
+| Variable                | Description                                | Example  |
+| ----------------------- | ------------------------------------------ | -------- |
+| `MOOMOO_TRADE_PASSWORD` | Your trading password (plain text)         | `123456` |
+| `MOOMOO_SECURITY_FIRM`  | Your broker region (e.g., FUTUSG, FUTUINC) | `FUTUSG` |
+
+> **Note**: Without these, the server runs in **SIMULATE-only mode** (paper trading).
+
+### 3. Configure Claude Desktop
+
+Add the server to your `claude_desktop_config.json`:
+
+#### Option A: Using PyPI Package (Recommended)
+
+```json
+{
+  "mcpServers": {
+    "moomoo": {
+      "command": "uvx",
+      "args": ["--refresh", "moomoo-api-mcp"],
+      "env": {
+        "MOOMOO_TRADE_PASSWORD": "your_trading_password",
+        "MOOMOO_SECURITY_FIRM": "FUTUSG"
+      }
+    }
+  }
+}
+```
+
+> **Note**: The `--refresh` flag ensures you always have the latest version but may increase startup time due to version checking. You can remove it once you have the correct version installed.
+
+#### Option B: Local Development
+
+```json
+{
+  "mcpServers": {
+    "moomoo": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "C:\\path\\to\\moomoo-api-mcp",
+        "run",
+        "moomoo-api-mcp"
+      ],
+      "env": {
+        "MOOMOO_TRADE_PASSWORD": "your_trading_password",
+        "MOOMOO_SECURITY_FIRM": "FUTUSG"
+      }
+    }
+  }
+}
+```
+
+> **Security**: Never commit your password to version control. The `env` block in the config file remains local.
+
+## AI Agent Guidance
+
+> **IMPORTANT**: All account tools default to **REAL** trading accounts.
+
+When using this MCP server, AI agents **MUST**:
+
+1. **Notify the user clearly** before accessing REAL account data. Example:
+
+   > "I'm about to access your **REAL trading account**. This will show your actual portfolio and balances."
+
+2. **Follow the unlock workflow** for REAL accounts:
+   - First call `unlock_trade` (it handles env vars automatically, or pass password if needed).
+   - Then call account/trading tools (they default to `trd_env='REAL'`).
+
+3. **Only use SIMULATE accounts when explicitly requested** by the user. To use simulation:
+   - Pass `trd_env='SIMULATE'` parameter explicitly.
+   - No unlock is required for simulation accounts.
+
+### Workflow Example
+
+```text
+User: "Show me my portfolio"
+
+Agent Response:
+"I'm accessing your REAL trading account to show your portfolio.
+If you prefer to use a simulation account instead, please let me know."
+
+[Proceeds to unlock_trade → get_account_summary]
+```
+
+### Order Status Filter Usage
+
+When using `get_orders` or `get_history_orders`, the `status_filter_list` parameter accepts an array of **string values**:
+
+```json
+["SUBMITTED", "FILLED_ALL", "CANCELLED_ALL"]
+```
+
+**Valid status strings:**
+
+- `UNSUBMITTED`, `WAITING_SUBMIT`, `SUBMITTING`, `SUBMIT_FAILED`
+- `SUBMITTED`, `FILLED_PART`, `FILLED_ALL`
+- `CANCELLING_PART`, `CANCELLING_ALL`, `CANCELLED_PART`, `CANCELLED_ALL`
+- `REJECTED`, `DISABLED`, `DELETED`, `FAILED`, `NONE`
+
+> **Note**: The server automatically converts these strings to the required SDK enum format. If no orders match the filter, an empty list is returned.
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+## Disclaimer
+
+**Unofficial Project**: This software is an independent open-source project and is **not** affiliated with, endorsed by, or sponsored by Moomoo Inc., Futu Holdings Ltd., or their affiliates.
+
+- **Use at your own risk**: Trading involves financial risk. The authors provide this software "as is" without warranty of any kind.
+- **Test First**: Always test your agents and tools in the **Simulation (Paper Trading)** environment before using real funds.

moomoo_api_mcp-0.1.6.dist-info/RECORD

@@ -0,0 +1,17 @@
+moomoo_mcp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+moomoo_mcp/server.py,sha256=hE8wz2XFbAXdb5-xImOglhTRCFjoHw6DN8osoOQo6uk,4025
+moomoo_mcp/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+moomoo_mcp/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+moomoo_mcp/services/base_service.py,sha256=tXFirBji5GOfyrGTdy5Qo6mXVX4v7ZAzM8SmjBhKcn4,1666
+moomoo_mcp/services/market_data_service.py,sha256=HMOeehYbfcCbaFMlzBVtMznjjJ745lVFGCoOtk4ldUQ,7668
+moomoo_mcp/services/trade_service.py,sha256=c8IE8AMmzwrgWkaITvV8PZXvv7NgGRQTa_QGM2t_9FE,23419
+moomoo_mcp/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+moomoo_mcp/tools/account.py,sha256=Se_c0cJaSXecy5vx2ks6A4WeCWE8E3_OhPu896zQOos,10904
+moomoo_mcp/tools/market_data.py,sha256=a-xT1S4btjQ3UpbWWvmqiiFyDxytYor1t9bYwx1ZhoA,7030
+moomoo_mcp/tools/system.py,sha256=R25KX6xB2sgsnd0Qqb-O02y0pH5ZMcpG6_EWfICCmgA,583
+moomoo_mcp/tools/trading.py,sha256=WloLCICvIktWuzR42jlz7uB4fTbZJcPK0mxIMCtJrOs,11766
+moomoo_api_mcp-0.1.6.dist-info/METADATA,sha256=CTNb-kGxdFfbQ22k16UlH6458i_72MWwyNROcNDYGAA,21472
+moomoo_api_mcp-0.1.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+moomoo_api_mcp-0.1.6.dist-info/entry_points.txt,sha256=R2KPW7-nzZbQUzbTMsxX_3MnObx50LDfgecvDcVwruU,58
+moomoo_api_mcp-0.1.6.dist-info/licenses/LICENSE,sha256=tBM6VSMsCZZxM0mJHcVUadRqFuwCfAM8nkEIshSau0I,11273
+moomoo_api_mcp-0.1.6.dist-info/RECORD,,

moomoo_api_mcp-0.1.6.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

moomoo_api_mcp-0.1.6.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+moomoo-api-mcp = moomoo_mcp.server:main