freqtrade-mcp

Created 6 months ago

An MCP server that integrates with the Freqtrade cryptocurrency trading bot via its REST API.

development documentation public cryptocurrency trading

What is freqtrade-mcp?

An MCP server that integrates with the Freqtrade cryptocurrency trading bot.

Documentation

Freqtrade-MCP

An MCP server that integrates with the Freqtrade cryptocurrency trading bot via its REST API, enabling seamless AI agent interaction for automated trading operation.

Installation# Prerequisites

Python 3.13+: Ensure Python is installed on your system.
Freqtrade: A running Freqtrade instance with the REST API enabled (see Freqtrade Docs).
Git: For cloning the repository.

Steps

Clone the Repository:

git clone https://github.com/kukapay/freqtrade-mcp.git
cd freqtrade-mcp

Install Dependencies: Using pip:

pip install freqtrade-client mcp[cli]

Or with uv (optional):

uv add freqtrade-client "mcp[cli]"

Client Configuration:

"mcpServers": {
    "freqtrade-mcp": {
        "command": "uv",
        "args": [ "--directory", "/your/path/to/freqtrade-mcp", "run", "__main__.py" ],
        "env": {
            "FREQTRADE_API_URL": "http://127.0.0.1:8080",
            "FREQTRADE_USERNAME": "your_username",
            "FREQTRADE_PASSWORD": "your_password"
        }
    }
}

Freqtrade Configuration: Enable the rest API by adding the api_server section to your configuration and setting api_server.enabled to true. Sample configuration:

"api_server": {
    "enabled": true,
    "listen_ip_address": "127.0.0.1",
    "listen_port": 8080,
    "verbosity": "error",
    "enable_openapi": false,
    "jwt_secret_key": "somethingrandom",
    "CORS_origins": [],
    "username": "Freqtrader",
    "password": "SuperSecret1!",
    "ws_token": "sercet_Ws_t0ken"
},

Check the document here.

Usage# Available Tools

The server exposes the following Freqtrade API endpoints as MCP tools:

Tool	Description	Parameters
`fetch_market_data`	Fetch OHLCV data for a pair	`pair: str`, `timeframe: str`
`fetch_bot_status`	Get open trade status	None
`fetch_profit`	Get profit summary	None
`fetch_balance`	Get account balance	None
`fetch_performance`	Get performance metrics	None
`fetch_whitelist`	Get whitelist of pairs	None
`fetch_blacklist`	Get blacklist of pairs	None
`fetch_trades`	Get trade history	None
`fetch_config`	Get bot configuration	None
`fetch_locks`	Get trade locks	None
`place_trade`	Place a buy/sell trade	`pair: str`, `side: str`, `stake_amount: float`
`start_bot`	Start the bot	None
`stop_bot`	Stop the bot	None
`reload_config`	Reload bot configuration	None
`add_blacklist`	Add pair to blacklist	`pair: str`
`delete_blacklist`	Remove pair from blacklist	`pair: str`
`delete_lock`	Delete a trade lock	`lock_id: int`

License

This project is licensed under the MIT License. See the LICENSE file for details.

Server Config

{
  "mcpServers": {
    "freqtrade-mcp-server": {
      "command": "npx",
      "args": [
        "freqtrade-mcp"
      ]
    }
  }
}

Links & Status

Repository: github.com

Hosted: No

Global: No

Official: No

Project Info

Hosted Featured

Created At: May 23, 2025

Updated At: Aug 07, 2025

Author: Kukapay

Category: community

License: MIT License

Tags:

development documentation public