Freqtrade MCP

🚀 FREQTRADE - MCP Project

FREQTRADE - MCP is an MCP server integrated with Freqtrade, enabling AI agent interaction through a REST API.

🚀 Quick Start

Prerequisites

• Python version requirement: Python 3.8 or higher.
• Ensure that Freqtrade is correctly installed and running.
• Install Git for code cloning and management.

Installation Steps

1. Clone the project repository using the following command:

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

2. Navigate to the project directory:

   cd freqtrade-mcp
   

3. Install the dependencies:

   pip install -r requirements.txt
   

4. Configure the environment variables to include the following:

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

5. Start the service:

   python server.py
   

📦 Installation

Configuring Freqtrade

Enable the REST API in Freqtrade and configure the following:

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

💻 Usage Examples

Available Tools

1. Get the current list of trading pairs

   • Function: List all available trading pairs.
   • Example query:

     GET /api/pairs
     

2. Query historical trading data

   • Function: Retrieve historical data based on the time range and trading pair.
   • Example query:

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

3. Execute a buy operation

   • Function: Execute a buy trade based on the specified parameters.
   • Example query:

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

Example Queries

Get the current portfolio

GET /api/portfolio

Query trade history

GET /api/trade - history?limit=10

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.