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 文件。