Freqtrade

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

python

107

GitHub Stars

python

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "kukapay-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_PASSWORD": "your_password",
        "FREQTRADE_USERNAME": "your_username"
      }
    }
  }
}

You install and run the Freqtrade-MCP server to expose Freqtrade REST API functions as MCP tools. This lets you interact with your Freqtrade instance through MCP clients, enabling actions like fetching market data, checking bot status, and placing trades in an automated, AI-assisted workflow.

How to use

Start by running the MCP server so your MCP client can connect and issue commands against your Freqtrade instance. The server exposes a set of tools that map directly to Freqtrade REST API endpoints. Use the MCP client to authenticate and then perform actions such as fetching OHLCV data, checking bot status, retrieving profit or performance metrics, managing blacklists/whitelists, and placing trades. Each tool accepts parameters as described in the tool list, and you can combine multiple tool calls to build automated trading workflows.

Available Tools Preview

The server provides a suite of tools that mirror Freqtrade REST API capabilities. Each tool corresponds to a specific API operation, such as retrieving market data or managing trades. Use these tools to query data, control the bot, or modify trading rules from within your MCP client.

Available tools

fetch_market_data

Fetch OHLCV data for a trading pair given a pair and a timeframe.

fetch_bot_status

Query the current open trade status and bot activity.

fetch_profit

Retrieve the profit summary for the bot.

fetch_balance

Get the account balance available in the Freqtrade wallet.

fetch_performance

Obtain bot performance metrics and statistics.

fetch_whitelist

List trading pairs that are whitelisted for trading.

fetch_blacklist

List trading pairs that are blacklisted from trading.

fetch_trades

Retrieve the history of completed trades.

fetch_config

Get the current bot configuration details.

fetch_locks

List active trading locks.

place_trade

Place a buy or sell order for a specified pair and stake amount.

start_bot

Start or resume the trading bot.

stop_bot

Stop the trading bot and halt trading activities.

reload_config

Reload the bot configuration without restarting the entire service.

add_blacklist

Add a trading pair to the blacklist.

delete_blacklist

Remove a trading pair from the blacklist.

delete_lock

Delete a specific trade lock by its ID.