liberatti/mt5bridge repository overview

┌───────────────────────────────────────────────────────────┐
│                    Client Applications                    │
│   (Web Apps / Python Scripts / Trading Bots / Postman)    │
└─────────────────────────────┬─────────────────────────────┘
                              │ HTTP / REST (Port 5000)
                              ▼
┌───────────────────────────────────────────────────────────┐
│                  Docker Container: mt5bridge              │
│                                                           │
│   ┌───────────────────────────────────────────────────┐   │
│   │  Swagger UI / OpenAPI 3.0 Documentation (/)       │   │
│   │  Flask REST API (Waitress Multi-threaded WSGI)    │   │
│   └─────────────────────────┬─────────────────────────┘   │
│                             │ TCP Socket (Port 22347)     │
│                             ▼                             │
│   ┌───────────────────────────────────────────────────┐   │
│   │  RestGateway Expert Advisor (MQL5)                │   │
│   │  MetaTrader 5 Terminal 64-bit                     │   │
│   │  WineHQ Staging + Xvfb Display Server             │   │
│   └─────────────────────────┬─────────────────────────┘   │
└─────────────────────────────┼─────────────────────────────┘
                              │ TCP (Broker Protocol)
                              ▼
┌───────────────────────────────────────────────────────────┐
│             MetaTrader 5 Broker Trading Server            │
└───────────────────────────────────────────────────────────┘

# Pull the latest Docker image
docker pull liberatti/mt5bridge:latest

# Run container with your demo or live broker credentials
docker run -d --name mt5bridge \
  -p 5000:5000 \
  -e MT5_LOGIN=112728385 \
  -e MT5_PASSWORD=YourPassword \
  -e MT5_SERVER=MetaQuotes-Demo \
  -e MT5_STARTUP_SYMBOL=EURUSD \
  -e MT5_STARTUP_PERIOD=H1 \
  liberatti/mt5bridge:latest

volumes:
  mt5_data:
    driver: local

services:
  metatrader5:
    image: liberatti/mt5bridge:latest
    container_name: mt5bridge
    restart: unless-stopped
    ports:
      - "5000:5000"
    environment:
      - MT5_LOGIN=112728385
      - MT5_PASSWORD=YourPassword
      - MT5_SERVER=MetaQuotes-Demo
      - MT5_STARTUP_SYMBOL=EURUSD
      - MT5_STARTUP_PERIOD=H1
      - API_KEY=YourSecretApiKey
    volumes:
      - mt5_data:/home/mt5user/.mt5

docker compose up -d

// Success Response (HTTP 200)
{
  "code": 200,
  "data": { ... }
}

// Error Response (HTTP 400 / 500)
{
  "code": 400,
  "message": "Validation Error / Bad Request",
  "details": "...",
  "url": "http://localhost:5000/api/...",
  "method": "POST"
}

import os
import requests

BASE_URL = "http://localhost:5000/api"
API_KEY = os.environ.get("API_KEY", "YourSecretApiKey")
HEADERS = {"x-api-key": API_KEY}

# 1. Check account balance & equity
account = requests.get(f"{BASE_URL}/account_info", headers=HEADERS).json()
print("Balance:", account["data"]["balance"], "Equity:", account["data"]["equity"])

# 2. Get real-time price tick
tick = requests.get(f"{BASE_URL}/symbol_info_tick/EURUSD", headers=HEADERS).json()
print("EURUSD Bid:", tick["data"]["bid"], "Ask:", tick["data"]["ask"])

# 3. Open a Market Buy Position
buy_res = requests.post(f"{BASE_URL}/order/open", headers=HEADERS, json={
    "symbol": "EURUSD",
    "order_type": "BUY",
    "volume": 0.01,
    "sl": 1.0500,
    "tp": 1.1000,
    "comment": "MT5Bridge Buy Order"
}).json()
print("Order Response:", buy_res)

# 4. List open positions
positions = requests.get(f"{BASE_URL}/positions_get", headers=HEADERS).json()
print("Open Positions:", positions["data"])

# Get MT5 version
curl -X GET "http://localhost:5000/api/version" \
  -H "x-api-key: YourSecretApiKey"

# Get EURUSD live tick
curl -X GET "http://localhost:5000/api/symbol_info_tick/EURUSD" \
  -H "x-api-key: YourSecretApiKey"

# Open Market Buy Order (0.01 lots)
curl -X POST "http://localhost:5000/api/order/open" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YourSecretApiKey" \
  -d '{
    "symbol": "EURUSD",
    "order_type": "BUY",
    "volume": 0.01,
    "comment": "Test Order"
  }'

# Run the test suite with API Key authentication
python test_api.py --url http://localhost:5000 --api-key "YourSecretApiKey" --symbol EURUSD --volume 0.01

# Or authenticate using environment variable
export API_KEY="YourSecretApiKey"
python test_api.py --url http://localhost:5000 --symbol EURUSD --volume 0.01