Introduction

What is the MT4 Web API?

Brokeret MT4 Web API is a REST API for managing MetaTrader 4 accounts, trades, and server operations via the MT4 Manager interface. Built for CRM integration, it provides 34 endpoints covering user management, balance operations, trade monitoring, and administrative functions.

Version: 1.0.0 | Total Endpoints: 34

Authentication

All endpoints (except health checks) require a JWT Bearer token. Obtain one via the login endpoint.

POST/api/auth/login

Authenticates with admin credentials and returns a JWT access token. Token expiry defaults to 8 hours and is auto-refreshed when close to expiry.

Request:

POST/api/auth/login
Content-Type: application/x-www-form-urlencoded

username=admin&password=your_password

Response:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}

Usage: Include the token in all subsequent requests:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Health & Connectivity

Endpoints for monitoring service health, MT4 server connectivity, and diagnostics.

GET/api/health

Returns API service status. Use for uptime monitoring and load balancer health checks.

Response:

{
  "status": "ok",
  "service": "mt4-manager-api",
  "version": "1.0.0"
}

GET/api/test/service-health

Checks whether the internal Windows MT4 service is reachable and has an active connection to the MT4 trade server.

Response:

{
  "status": "ok",
  "service": "mt4-service",
  "connected": true
}

GET/api/test/status

Returns the current connection status of the MT4 service to the trade server.

Response:

{
  "status": "ok",
  "connected": true
}

GET/api/test/ping

Sends a ping to the MT4 trade server. Verifies the connection is alive.

Response:

{
  "status": "ok",
  "ping": true
}

GET/api/test/server-time

Returns the MT4 server's current time as both Unix timestamp and human-readable UTC string.

Response:

{
  "status": "ok",
  "server_time": 1772901814,
  "server_time_str": "2026-03-07 16:43:34 UTC"
}

POST/api/test/connect

Manually connects the MT4 service to a trade server. Typically not needed as the service auto-connects on startup with auto-reconnect.

Request Body:

{
  "server": "203.0.113.10:443",
  "login": 224,
  "password": "your_manager_password"
}

Response:

{
  "status": "ok",
  "message": "Connected and logged in successfully"
}

POST/api/test/disconnect

Disconnects the MT4 service from the trade server. All MT4 operations will fail until reconnected.

Response:

{
  "status": "ok",
  "message": "Disconnected"
}

Quick Reference

Next Steps

• API Endpoints — Full endpoint reference for users, accounts, trades, groups, symbols, and admin operations
• Data Models — User, trade, and margin record schemas, error handling, and notes