Freqtrade MCP

🚀 FREQTRADE - MCP 項目

FREQTRADE - MCP 是一個與 Freqtrade 集成的 MCP 服務器，藉助 REST API 實現 AI 代理交互，為交易操作提供便利。

🚀 快速開始

FREQTRADE - MCP 需與 Freqtrade 配合使用，要先完成 FREQTRADE - MCP 的安裝，再對 Freqtrade 進行配置，之後就能使用其提供的工具開展交易操作。

📦 安裝指南

先決條件

• Python 版本要求為 Python 3.8 或更高版本。
• 需確保 Freqtrade 已正確安裝並運行。
• 要安裝 Git 用於代碼克隆和管理。

安裝步驟

1. 使用以下命令克隆項目倉庫：

   git clone https://github.com/yourusername/freqtrade-mcp.git
   

2. 進入項目目錄：

   cd freqtrade-mcp
   

3. 安裝依賴項：

   pip install -r requirements.txt
   

4. 配置環境變量，確保包含以下內容：

   {
     "FREQTRADE_API_URL": "http://localhost:8080",
     "FREQTRADE_USERNAME": "your_username",
     "FREQTRADE_PASSWORD": "your_password"
   }
   

5. 啟動服務：

   python server.py
   

🔧 配置 Freqtrade

在 Freqtrade 中啟用 REST API 並配置以下內容：

{
  "rest_api": {
    "enabled": true,
    "host": "localhost",
    "port": 8080,
    "username": "your_username",
    "password": "your_password"
  }
}

💻 使用示例

可用工具

基礎用法

• 獲取當前交易對列表
  • 功能：列出所有可用的交易對。
  • 示例查詢：

    GET /api/pairs
    

• 查詢歷史交易數據
  • 功能：根據時間範圍和交易對獲取歷史數據。
  • 示例查詢：

    GET /api/historical/BTCUSDT?start=2023-01-01&end=2023-12-31
    

高級用法

• 執行買入操作
  • 功能：根據指定參數執行買入交易。
  • 示例查詢：

    POST /api/trade/buy
    {
      "pair": "BTCUSDT",
      "amount": 0.5,
      "price": 40000
    }
    

其他示例查詢

基礎用法

• 獲取當前持倉

  GET /api/portfolio
  

高級用法

• 查詢交易記錄

  GET /api/trade - history?limit=10
  

📄 許可證

本項目遵循 MIT License，詳細內容請參考 LICENSE 文件。