mt5api 0.0.2

MetaTrader 5 REST API

mt5api

MetaTrader 5 REST API using FastAPI

mt5api exposes read-only MT5 market data, account info, and trading history over HTTP. It uses the pdmt5 client internally and adds optional API-key auth, rate limiting, and JSON/Parquet response formatting.

The API server must run on Windows. The MetaTrader5 Python package used by pdmt5 is supported only on Windows, so you must host mt5api on a Windows machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect from any operating system.

Features

• Read-only REST endpoints for symbols, market data, account info, orders, and history
• JSON and Apache Parquet responses (content negotiation)
• Optional API key authentication with per-minute rate limiting
• Structured JSON logging and configurable CORS
• OpenAPI/Swagger docs built into the API

Requirements

• Python 3.11+
• Windows host with MetaTrader 5 terminal installed and logged in
• Linux and macOS are not supported for the API server runtime, but they work for HTTP clients

Installation

Install and run the API on the Windows machine where MetaTrader 5 is installed.

git clone https://github.com/dceoy/mt5api.git
cd mt5api
uv sync

Running the API on Windows

$env:MT5_API_KEY = "your-secret-api-key"  # Optional: omit to disable auth
uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000

Docs:

• Swagger UI: http://localhost:8000/docs
• OpenAPI JSON: http://localhost:8000/openapi.json

Example Requests with curl

Replace windows-host with the DNS name or IP address of the Windows machine running mt5api. If you run the request on that Windows host, localhost also works. In PowerShell, use curl.exe if curl resolves to Invoke-WebRequest.

curl "http://windows-host:8000/api/v1/health"

# Include X-API-Key only when MT5_API_KEY is configured on the server.
curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/api/v1/symbols?group=*USD*"

curl -H "X-API-Key: your-secret-api-key" -H "Accept: application/parquet" "http://windows-host:8000/api/v1/rates/from?symbol=EURUSD&timeframe=1&date_from=2024-01-01T00:00:00Z&count=100"

Endpoints (Read-Only)

• Health: /api/v1/health, /api/v1/version
• Symbols: /api/v1/symbols, /api/v1/symbols/{symbol}, /api/v1/symbols/{symbol}/tick
• Market data: /api/v1/rates/from, /api/v1/rates/from-pos, /api/v1/rates/range, /api/v1/ticks/from, /api/v1/ticks/range, /api/v1/market-book/{symbol}
• Account: /api/v1/account, /api/v1/terminal
• Trading state: /api/v1/positions, /api/v1/orders
• History: /api/v1/history/orders, /api/v1/history/deals

License

MIT License - see LICENSE.