From 456ec14c7f26422b29d0ee4c4bb54e2e26a3e568 Mon Sep 17 00:00:00 2001 From: Daichi Narushima <1938249+dceoy@users.noreply.github.com> Date: Sun, 28 Jun 2026 00:06:39 +0900 Subject: [PATCH 1/2] docs: clarify mt5api operational scope --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6605a52..20c04fa 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,16 @@ MetaTrader 5 REST API [![CI/CD](https://github.com/dceoy/mt5api/actions/workflows/ci.yml/badge.svg)](https://github.com/dceoy/mt5api/actions/workflows/ci.yml) -mt5api exposes MT5 market data, account info, trading history, and trading -operations over HTTP. It is a FastAPI/HTTP adapter over -[`pdmt5`](https://github.com/dceoy/pdmt5), which provides the core MT5 client, -dataframe/trading primitives, and canonical MT5 constant parsing. mt5api adds -optional API-key auth and JSON/Parquet response formatting. +mt5api exposes MT5 market data, account info, trading history, trading state, +order validation, and operational terminal endpoints over HTTP. It is a +FastAPI/HTTP adapter over [`pdmt5`](https://github.com/dceoy/pdmt5), which +provides the core MT5 client, dataframe/order primitives, and canonical MT5 +constant parsing. mt5api adds optional API-key auth and JSON/Parquet response +formatting. + +The exposed operational surface is deliberately narrow: mt5api validates trade +requests and manages terminal-side subscriptions or MarketWatch visibility, but +it does not expose live order-send endpoints or implement strategy orchestration. The API server must run on Windows. pdmt5 connects through the MetaTrader 5 Python API, which is supported only on Windows, so you must host `mt5api` on a @@ -43,8 +48,8 @@ graph TB ## Features -- REST endpoints for symbols, market data, account info, orders, history, - calculations, and trading operations +- REST endpoints for symbols, market data, account info, orders, positions, + history, margin/profit calculations, order validation, and terminal operations - JSON and Apache Parquet responses (content negotiation) - Optional API key authentication - Structured JSON logging From 2bbd8ac4bbaeae78fbd483da6b362fd001eef5e2 Mon Sep 17 00:00:00 2001 From: agent Date: Sat, 27 Jun 2026 15:16:39 +0000 Subject: [PATCH 2/2] docs: add /connection/login to operational scope; fix subscription wording Address review feedback: mention POST /connection/login in the operational surface paragraph (it reconnects the terminal to a different MT5 account, which reviewers flagged as missing), and replace "or" with "and" for terminal-side subscriptions and MarketWatch visibility. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20c04fa..43d3c51 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,10 @@ constant parsing. mt5api adds optional API-key auth and JSON/Parquet response formatting. The exposed operational surface is deliberately narrow: mt5api validates trade -requests and manages terminal-side subscriptions or MarketWatch visibility, but -it does not expose live order-send endpoints or implement strategy orchestration. +requests, manages terminal-side subscriptions and MarketWatch visibility, and +supports reconnecting the terminal to a different MT5 account via +`POST /connection/login`, but it does not expose live order-send endpoints or +implement strategy orchestration. The API server must run on Windows. pdmt5 connects through the MetaTrader 5 Python API, which is supported only on Windows, so you must host `mt5api` on a