mt5api 0.1.0__tar.gz → 0.3.0__tar.gz

{mt5api-0.1.0 → mt5api-0.3.0}/.agents/skills/local-qa/SKILL.md

@@ -1,7 +1,7 @@
 ---
 name: local-qa
 description: Run local QA including formatting, linting, and testing for the repository. Use whenever any file has been updated.
-disable-model-invocation: true
+disable-model-invocation: false
 ---
 
 # Local QA (format, lint, and test)

{mt5api-0.1.0 → mt5api-0.3.0}/.agents/skills/local-qa/scripts/qa.sh

@@ -10,7 +10,7 @@ uv run pyright .
 uv run pytest
 
 # Markdown
-npx prettier --write './**/*.md'
+npx -y prettier --write './**/*.md'
 
 # GitHub Actions
 case "${OSTYPE}" in

{mt5api-0.1.0 → mt5api-0.3.0}/.agents/skills/mt5api/SKILL.md

@@ -3,8 +3,8 @@ name: mt5api
 description: >-
   Query the MT5 API for account info, terminal status, health checks, symbol
   data, market data (OHLCV rates, ticks, market depth), open positions, pending
-  orders, and trade history. Use when the user wants to interact with any mt5api
-  endpoint.
+  orders, trade history, and reconnecting the MT5 terminal with new
+  credentials. Use when the user wants to interact with any mt5api endpoint.
 allowed-tools: Bash
 ---
 
@@ -30,6 +30,16 @@ if [ -n "${MT5API_SECRET_KEY:-}" ]; then
 fi
 ```
 
+Login credentials for `/connection/login` are read from the environment so
+the password is never hard-coded in a command:
+
+| Variable          | Description                                | Required for login |
+| ----------------- | ------------------------------------------ | ------------------ |
+| `MT5API_LOGIN`    | Trading account login (integer)            | yes                |
+| `MT5API_PASSWORD` | Trading account password                   | yes                |
+| `MT5API_SERVER`   | Trading server name (e.g., `Broker-Demo`)  | yes                |
+| `MT5API_TIMEOUT`  | Connection timeout in milliseconds (`> 0`) | no                 |
+
 ## Response Formats
 
 All endpoints (except `/health`) return JSON by default. Request Parquet with
@@ -44,6 +54,11 @@ All endpoints (except `/health`) return JSON by default. Request Parquet with
   symbol or skipping DOM data.
 - Empty arrays from `/positions`, `/orders`, `/history/orders`, or
   `/history/deals` are valid results.
+- `/connection/login` reconnects the shared MT5 client to a different account.
+  It shuts down the current connection and releases any active market-book
+  subscriptions before logging in. Never echo the password back to the user
+  and do not log it; the response only confirms `login`, `server`, `timeout`,
+  and `connected`.
 
 ---
 
@@ -77,6 +92,59 @@ curl -s "${AUTH_HEADER[@]}" \
 
 ---
 
+## Connection
+
+### Reconnect to MT5
+
+Shut down the current MT5 client and reconnect with new credentials. Active
+market-book subscriptions are released first. The call is serialized so
+concurrent reconnect attempts do not race. The password is sent only in the
+request body and is never echoed in the response.
+
+```bash
+# Build JSON body from env vars; include timeout only when set
+LOGIN_BODY=$(python3 -c "
+import json, os, sys
+body = {
+    'login': int(os.environ['MT5API_LOGIN']),
+    'password': os.environ['MT5API_PASSWORD'],
+    'server': os.environ['MT5API_SERVER'],
+}
+t = os.environ.get('MT5API_TIMEOUT')
+if t:
+    body['timeout'] = int(t)
+print(json.dumps(body))
+")
+curl -s -X POST "${AUTH_HEADER[@]}" \
+  -H 'Content-Type: application/json' \
+  -d "${LOGIN_BODY}" \
+  "${MT5API_URL}/connection/login" | python -m json.tool
+```
+
+Request body:
+
+| Field    | Type   | Required | Description                                |
+| -------- | ------ | -------- | ------------------------------------------ |
+| login    | int    | yes      | Trading account login (positive integer)   |
+| password | string | yes      | Trading account password (never echoed)    |
+| server   | string | yes      | Trading server name (e.g., `Broker-Demo`)  |
+| timeout  | int    | no       | Connection timeout in milliseconds (`> 0`) |
+
+Successful response (`200`):
+
+| Field     | Type   | Description                                  |
+| --------- | ------ | -------------------------------------------- |
+| login     | int    | Login that was used to connect               |
+| server    | string | Trading server that was connected to         |
+| timeout   | int?   | Timeout in milliseconds if one was specified |
+| connected | bool   | `true` when the new connection succeeded     |
+
+On failure, MT5 errors surface as `503 Service Unavailable` with an RFC 7807
+problem-details body. Never include the supplied password in any summary or
+diagnostic you return to the user.
+
+---
+
 ## Account & Terminal
 
 ### Account Info
@@ -323,3 +391,6 @@ Either `(date_from AND date_to)` or `(ticket OR position)` must be provided.
    running or reachable.
 9. For historical queries, remind the user that either a date range or a
    ticket/position filter is required.
+10. For `/connection/login`, always send the password in the POST body and
+    never repeat it in any reply or log message. If the user asks you to
+    reconnect, confirm the target `login`/`server` before sending the request.

{mt5api-0.1.0 → mt5api-0.3.0}/.github/workflows/ci.yml

@@ -19,7 +19,6 @@ on:
         options:
           - lint-and-test
           - docs-deploy
-          - release
         description: Choose the workflow to run
         default: lint-and-test
 permissions:
@@ -54,10 +53,7 @@ jobs:
   python-docs-deploy:
     if: >
       github.event_name == 'push'
-      || (
-        github.event_name == 'workflow_dispatch'
-        && (inputs.workflow == 'docs-deploy' || inputs.workflow == 'release')
-      )
+      || (github.event_name == 'workflow_dispatch' && inputs.workflow == 'docs-deploy')
     permissions:
       contents: write
     uses: dceoy/gh-actions-for-devops/.github/workflows/python-package-mkdocs-gh-deploy.yml@main  # zizmor: ignore[unpinned-uses]
@@ -66,23 +62,6 @@ jobs:
       runs-on: ubuntu-slim
     secrets:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  python-package-release:
-    if: >
-      github.event_name == 'push'
-      || (
-        github.event_name == 'workflow_dispatch'
-        && (inputs.workflow == 'release' || inputs.workflow == 'lint-and-test')
-      )
-    permissions:
-      contents: write
-      id-token: write
-    uses: dceoy/gh-actions-for-devops/.github/workflows/python-package-release-on-pypi-and-github.yml@main  # zizmor: ignore[unpinned-uses]
-    with:
-      package-path: .
-      create-releases: ${{ github.event_name == 'workflow_dispatch' && inputs.workflow == 'release' }}
-    secrets:
-      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
-      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   dependabot-auto-merge:
     if: >
       github.event_name == 'pull_request' && github.actor == 'dependabot[bot]'

mt5api-0.1.0/.github/workflows/claude-code.yml → mt5api-0.3.0/.github/workflows/claude.yml

@@ -26,7 +26,7 @@ jobs:
   claude-code-review:
     if: >
       github.event_name == 'pull_request'
-      && github.event.pull_request.draft == false
+      && (! github.event.pull_request.draft)
       && (! startsWith(github.head_ref, 'dependabot/'))
       && (! startsWith(github.head_ref, 'renovate/'))
     permissions:
@@ -37,7 +37,7 @@ jobs:
       actions: read
     uses: dceoy/gh-actions-for-devops/.github/workflows/claude-code-review.yml@main  # zizmor: ignore[unpinned-uses]
     secrets:
-      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}   # zizmor: ignore[secrets-outside-env]
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}  # zizmor: ignore[secrets-outside-env]
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   claude-code-bot:
     if: >
@@ -53,5 +53,5 @@ jobs:
       actions: read
     uses: dceoy/gh-actions-for-devops/.github/workflows/claude-code-bot.yml@main  # zizmor: ignore[unpinned-uses]
     secrets:
-      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}   # zizmor: ignore[secrets-outside-env]
+      CLAUDE_CODE_OAUTH_TOKEN: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}  # zizmor: ignore[secrets-outside-env]
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

mt5api-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+---
+name: Release
+on:
+  workflow_dispatch:
+permissions:
+  contents: read
+defaults:
+  run:
+    shell: bash -euo pipefail {0}
+    working-directory: .
+jobs:
+  build-and-release:
+    permissions:
+      contents: write
+      id-token: write
+    uses: dceoy/gh-actions-for-devops/.github/workflows/python-package-release-on-pypi-and-github.yml@main  # zizmor: ignore[unpinned-uses]
+    with:
+      package-path: .
+      create-github-release: true
+      publish-to-pypi: false
+    secrets:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  publish-to-pypi:
+    name: Publish the Python 🐍 distribution 📦 to PyPI
+    if: >
+      startsWith(github.ref, 'refs/tags/')
+    needs:
+      - build-and-release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ needs.build-and-release.outputs.project-name }}
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
+        with:
+          name: ${{ needs.build-and-release.outputs.distribution-artifact-name }}
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
+        with:
+          verbose: true

{mt5api-0.1.0 → mt5api-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mt5api
-Version: 0.1.0
+Version: 0.3.0
 Summary: MetaTrader 5 REST API
 Project-URL: Repository, https://github.com/dceoy/mt5api.git
 Author-email: dceoy <dceoy@users.noreply.github.com>
@@ -18,11 +18,8 @@ Classifier: Topic :: Office/Business :: Financial :: Investment
 Requires-Python: <3.14,>=3.11
 Requires-Dist: fastapi>=0.115.0
 Requires-Dist: httpx>=0.27.0
-Requires-Dist: metatrader5>=5.0.4424; sys_platform == 'win32'
-Requires-Dist: passlib[bcrypt]>=1.7.4
-Requires-Dist: pdmt5>=0.2.1
+Requires-Dist: pdmt5>=0.3.0
 Requires-Dist: pyarrow>=18.0.0
-Requires-Dist: python-jose[cryptography]>=3.3.0
 Requires-Dist: python-multipart>=0.0.9
 Requires-Dist: uvicorn[standard]>=0.32.0
 Description-Content-Type: text/markdown
@@ -34,14 +31,18 @@ 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 uses the [`pdmt5`](https://github.com/dceoy/pdmt5)
-client internally and adds optional API-key auth and JSON/Parquet response
-formatting.
+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.
 
-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.
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+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
+Windows machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect
+from any operating system.
 
 ## Architecture
 
@@ -61,7 +62,7 @@ graph TB
             Formatters --> Middleware
         end
 
-        Deps --> pdmt5["pdmt5<br/>MT5 Client Library"]
+        Deps --> pdmt5["pdmt5<br/>MT5 Client · Constants · Dataframes"]
         pdmt5 --> MT5["MetaTrader 5<br/>Terminal"]
     end
 
@@ -89,6 +90,20 @@ graph TB
 
 Install and run the API on the Windows machine where MetaTrader 5 is installed.
 
+Install the latest release from PyPI:
+
+```console
+pip install mt5api
+```
+
+Or, when managing the project with `uv`, add it as a dependency:
+
+```console
+uv add mt5api
+```
+
+Alternatively, install from source:
+
 ```powershell
 git clone https://github.com/dceoy/mt5api.git
 cd mt5api
@@ -97,12 +112,24 @@ uv sync
 
 ## Running the API on Windows
 
+After installing from PyPI:
+
 ```powershell
 $env:MT5API_SECRET_KEY = "your-secret-api-key"  # Optional: omit to disable auth
 $env:MT5API_ROUTER_PREFIX = "/api/v1"     # Optional: omit for root-level routes
-uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000
+python -m mt5api
+```
+
+`python -m mt5api` reads `MT5API_HOST`, `MT5API_PORT`, and `MT5API_LOG_LEVEL`
+from the environment. You can also invoke `uvicorn` directly:
+
+```powershell
+uvicorn mt5api.main:app --host 0.0.0.0 --port 8000
 ```
 
+If you cloned the source tree, prepend `uv run` to either command (for example,
+`uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000`).
+
 Docs:
 
 - Swagger UI: `http://localhost:8000/docs`
@@ -136,9 +163,9 @@ curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/symbols?group
 curl -H "X-API-Key: your-secret-api-key" -H "Accept: application/parquet" "http://windows-host:8000/rates/from?symbol=EURUSD&timeframe=TIMEFRAME_M1&date_from=2024-01-01T00:00:00Z&count=100"
 ```
 
-Market-data and calculation endpoints accept MetaTrader 5 constants either by
-official name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`) or by their
-integer value.
+Market-data and calculation endpoints accept MetaTrader 5 constants by official
+name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`), short alias (`M1`,
+`ALL`, `BUY`), or integer value.
 
 ## Endpoints
 

{mt5api-0.1.0 → mt5api-0.3.0}/README.md

@@ -5,14 +5,18 @@ 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 uses the [`pdmt5`](https://github.com/dceoy/pdmt5)
-client internally and adds optional API-key auth and JSON/Parquet response
-formatting.
+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.
 
-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.
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+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
+Windows machine with a logged-in MetaTrader 5 terminal. HTTP clients can connect
+from any operating system.
 
 ## Architecture
 
@@ -32,7 +36,7 @@ graph TB
             Formatters --> Middleware
         end
 
-        Deps --> pdmt5["pdmt5<br/>MT5 Client Library"]
+        Deps --> pdmt5["pdmt5<br/>MT5 Client · Constants · Dataframes"]
         pdmt5 --> MT5["MetaTrader 5<br/>Terminal"]
     end
 
@@ -60,6 +64,20 @@ graph TB
 
 Install and run the API on the Windows machine where MetaTrader 5 is installed.
 
+Install the latest release from PyPI:
+
+```console
+pip install mt5api
+```
+
+Or, when managing the project with `uv`, add it as a dependency:
+
+```console
+uv add mt5api
+```
+
+Alternatively, install from source:
+
 ```powershell
 git clone https://github.com/dceoy/mt5api.git
 cd mt5api
@@ -68,12 +86,24 @@ uv sync
 
 ## Running the API on Windows
 
+After installing from PyPI:
+
 ```powershell
 $env:MT5API_SECRET_KEY = "your-secret-api-key"  # Optional: omit to disable auth
 $env:MT5API_ROUTER_PREFIX = "/api/v1"     # Optional: omit for root-level routes
-uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000
+python -m mt5api
+```
+
+`python -m mt5api` reads `MT5API_HOST`, `MT5API_PORT`, and `MT5API_LOG_LEVEL`
+from the environment. You can also invoke `uvicorn` directly:
+
+```powershell
+uvicorn mt5api.main:app --host 0.0.0.0 --port 8000
 ```
 
+If you cloned the source tree, prepend `uv run` to either command (for example,
+`uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000`).
+
 Docs:
 
 - Swagger UI: `http://localhost:8000/docs`
@@ -107,9 +137,9 @@ curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/symbols?group
 curl -H "X-API-Key: your-secret-api-key" -H "Accept: application/parquet" "http://windows-host:8000/rates/from?symbol=EURUSD&timeframe=TIMEFRAME_M1&date_from=2024-01-01T00:00:00Z&count=100"
 ```
 
-Market-data and calculation endpoints accept MetaTrader 5 constants either by
-official name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`) or by their
-integer value.
+Market-data and calculation endpoints accept MetaTrader 5 constants by official
+name (`TIMEFRAME_M1`, `COPY_TICKS_ALL`, `ORDER_TYPE_BUY`), short alias (`M1`,
+`ALL`, `BUY`), or integer value.
 
 ## Endpoints
 

{mt5api-0.1.0 → mt5api-0.3.0}/docs/api/rest-api.md

@@ -108,22 +108,23 @@ If `MT5API_ROUTER_PREFIX` is configured, prepend it to each API route below.
 
 ### Market Data
 
-- `timeframe` and `flags` accept either the official MetaTrader 5 constant
-  name (for example `TIMEFRAME_M1`, `COPY_TICKS_ALL`) or the equivalent integer
-  value.
+- `timeframe` and `flags` accept the official MetaTrader 5 constant name (for
+  example `TIMEFRAME_M1`, `COPY_TICKS_ALL`), a short alias (for example `M1`,
+  `ALL`), or the equivalent integer value.
 - `GET /rates/from` (`symbol`, `timeframe`, `date_from`, `count`, `format`)
 - `GET /rates/from-pos` (`symbol`, `timeframe`, `start_pos`, `count`, `format`)
 - `GET /rates/range` (`symbol`, `timeframe`, `date_from`, `date_to`, `format`)
 - `GET /ticks/from` (`symbol`, `date_from`, `count`, `flags`, `format`)
 - `GET /ticks/range` (`symbol`, `date_from`, `date_to`, `flags`, `format`)
-- `GET /market-book/{symbol}` (`format`) — Market depth (DOM) *(experimental)*
-- `POST /market-book/{symbol}/subscribe` — Subscribe to DOM events *(experimental)*
-- `POST /market-book/{symbol}/unsubscribe` — Unsubscribe from DOM events *(experimental)*
+- `GET /market-book/{symbol}` (`format`) — Market depth (DOM) _(experimental)_
+- `POST /market-book/{symbol}/subscribe` — Subscribe to DOM events _(experimental)_
+- `POST /market-book/{symbol}/unsubscribe` — Unsubscribe from DOM events _(experimental)_
 
 ### Calculations
 
-- `action` accepts either the official MetaTrader 5 constant name (for example
-  `ORDER_TYPE_BUY`) or the equivalent integer value.
+- `action` accepts the official MetaTrader 5 constant name (for example
+  `ORDER_TYPE_BUY`), a short alias (for example `BUY`), or the equivalent
+  integer value.
 - `GET /calc/margin` (`action`, `symbol`, `volume`, `price`, `format`) —
   Calculate required margin in account currency
 - `GET /calc/profit` (`action`, `symbol`, `volume`, `price_open`,
@@ -162,6 +163,14 @@ structure](https://www.mql5.com/en/docs/constants/structures/mqltraderequest),
 with typed validation for core fields such as `action`, `symbol`, `volume`,
 `type`, and `price`.
 
+### Connection
+
+- `POST /connection/login` (body: `{"login": ..., "password": "...",
+"server": "...", "timeout": ...}`) — Reconnect the MT5 terminal with the
+  supplied credentials. Any active market-book subscriptions are released and
+  the previous MT5 client is shut down before the new connection is
+  established. The supplied password is never echoed in responses or logs.
+
 ## Response Formatter Utilities
 
 If you are extending the API with custom endpoints, use the formatter helpers
@@ -291,6 +300,14 @@ curl -X POST -H "X-API-Key: your-secret-api-key" -H "Content-Type: application/j
   "http://windows-host:8000/order/check"
 ```
 
+### Reconnect to MT5
+
+```console
+curl -X POST -H "X-API-Key: your-secret-api-key" -H "Content-Type: application/json" \
+  -d '{"login": 12345678, "password": "s3cret", "server": "MetaQuotes-Demo", "timeout": 60000}' \
+  "http://windows-host:8000/connection/login"
+```
+
 ## Error Responses
 
 Errors follow RFC 7807 Problem Details:

{mt5api-0.1.0 → mt5api-0.3.0}/docs/index.md

@@ -5,14 +5,18 @@ trading operations.
 
 ## Overview
 
-mt5api exposes MT5 data and trading operations over HTTP using FastAPI. It
-relies on the underlying MT5 client library for connectivity and adds optional
-authentication and response formatting suitable for analytics
-workflows.
-
-The API server must run on Windows because the `MetaTrader5` Python package is
-Windows-only. Run `mt5api` on a Windows host with MetaTrader 5 installed and
-logged in. API clients can connect from any operating system.
+mt5api is a FastAPI/HTTP adapter over
+[`pdmt5`](https://github.com/dceoy/pdmt5). pdmt5 provides the core MT5 client,
+dataframe/trading primitives, and canonical MT5 constant parsing. mt5api adds
+optional authentication, response formatting, and OpenAPI documentation.
+
+[`mt5cli`](https://github.com/dceoy/mt5cli) is a sibling CLI/batch adapter for
+the same pdmt5 stack; it is not a dependency of mt5api.
+
+The API server must run on Windows because pdmt5 connects through the MetaTrader
+5 Python API, which is Windows-only. Run `mt5api` on a Windows host with
+MetaTrader 5 installed and logged in. API clients can connect from any operating
+system.
 
 ## Features