mt5api 0.0.2__tar.gz → 0.0.4__tar.gz

mt5api-0.0.4/.agents/skills/local-qa/SKILL.md

@@ -0,0 +1,22 @@
+---
+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
+---
+
+# Local QA (format, lint, and test)
+
+Run the local QA script `scripts/qa.sh` in this skill.
+
+## Procedure
+
+- Execute the script exactly as shown above when this skill is triggered.
+- Capture and summarize key output (success/failure, major warnings, and any files modified).
+- If the script fails due to missing tooling (`command not found`, missing executable, or equivalent), install the missing tool(s) and rerun `./scripts/qa.sh`.
+- Install tools using this order of preference:
+  1. Use the project's package manager when applicable (`uv`/`poetry` for Python, package manager scripts/dependencies for Node.js).
+  2. Use a system package manager (`brew` on macOS, `apt` on Debian/Ubuntu) when project-local install is not applicable.
+  3. Use language-specific installers as fallback (`pipx`/`pip`, `npm`, `go install`, etc.).
+- If multiple tools are missing, repeat install -> rerun until QA completes or you hit a blocker.
+- If installation fails or requires unavailable privileges, report what was attempted, the exact failure, and stop.
+- Do not run unrelated commands; only run commands needed for QA and missing-tool installation.

mt5api-0.0.4/.agents/skills/mt5api/SKILL.md

@@ -0,0 +1,325 @@
+---
+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.
+allowed-tools: Bash
+---
+
+# MT5 API
+
+Query all mt5api endpoints: health, version, account, terminal, symbols, market
+data, positions, orders, and trade history.
+
+## Configuration
+
+The API base URL defaults to `http://localhost:8000`. Set `MT5API_URL` to
+override. When the server is configured with `MT5API_SECRET_KEY`, send the same value
+in the `X-API-Key` header. When server-side auth is disabled, omit the header
+instead of sending an empty `X-API-Key`.
+
+Use these shell helpers in examples:
+
+```bash
+MT5API_URL="${MT5API_URL:-http://localhost:8000}"
+AUTH_HEADER=()
+if [ -n "${MT5API_SECRET_KEY:-}" ]; then
+  AUTH_HEADER=(-H "X-API-Key: ${MT5API_SECRET_KEY}")
+fi
+```
+
+## Response Formats
+
+All endpoints (except `/health`) return JSON by default. Request Parquet with
+`format=parquet` or `Accept: application/parquet`.
+
+## Operational Notes
+
+- Start `ticks/range` with a narrow window. Large ranges can be slow; use
+  `ticks/from` when the user only needs the latest `N` ticks.
+- `/market-book/{symbol}` may return `503` when MT5 depth-of-market data is not
+  available for the symbol. Report the exact MT5 error and suggest another
+  symbol or skipping DOM data.
+- Empty arrays from `/positions`, `/orders`, `/history/orders`, or
+  `/history/deals` are valid results.
+
+---
+
+## Health & Version
+
+### Health Check (public, no auth required)
+
+```bash
+curl -s "${MT5API_URL}/health" | python -m json.tool
+```
+
+Returns:
+
+| Field         | Type    | Description                    |
+| ------------- | ------- | ------------------------------ |
+| status        | string  | `healthy` or `unhealthy`       |
+| mt5_connected | bool    | MT5 terminal connection status |
+| mt5_version   | string? | MT5 terminal version string    |
+| api_version   | string  | API version (e.g., `1.0.0`)    |
+
+### MT5 Version
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/version" | python -m json.tool
+```
+
+| Parameter | Type   | Required | Description              |
+| --------- | ------ | -------- | ------------------------ |
+| format    | string | no       | Response format override |
+
+---
+
+## Account & Terminal
+
+### Account Info
+
+Get current trading account details (balance, equity, margin, leverage, etc.).
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/account" | python -m json.tool
+```
+
+Key fields: `login`, `balance`, `equity`, `margin`, `margin_free`,
+`margin_level`, `leverage`, `currency`, `server`, `name`.
+
+| Parameter | Type   | Required | Description              |
+| --------- | ------ | -------- | ------------------------ |
+| format    | string | no       | Response format override |
+
+### Terminal Info
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/terminal" | python -m json.tool
+```
+
+| Parameter | Type   | Required | Description              |
+| --------- | ------ | -------- | ------------------------ |
+| format    | string | no       | Response format override |
+
+---
+
+## Symbols
+
+### List Symbols
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/symbols" | python -m json.tool
+```
+
+| Parameter | Type   | Required | Description                                   |
+| --------- | ------ | -------- | --------------------------------------------- |
+| group     | string | no       | Symbol group filter (e.g., `*USD*`, `Forex*`) |
+| format    | string | no       | Response format override                      |
+
+### Get Symbol Info
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/symbols/EURUSD" | python -m json.tool
+```
+
+### Get Latest Tick
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/symbols/EURUSD/tick" | python -m json.tool
+```
+
+---
+
+## Market Data
+
+`timeframe` and `flags` accept either the official MetaTrader 5 constant name
+(e.g., `TIMEFRAME_H1`, `COPY_TICKS_ALL`) or the equivalent integer value.
+
+### Rates from Date
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/rates/from?symbol=EURUSD&timeframe=TIMEFRAME_H1&date_from=2024-01-01T00:00:00Z&count=100" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Description                                  |
+| --------- | -------- | -------- | -------------------------------------------- |
+| symbol    | string   | yes      | Symbol name                                  |
+| timeframe | int/str  | yes      | MT5 timeframe constant or equivalent integer |
+| date_from | datetime | yes      | Start date (ISO 8601)                        |
+| count     | int      | yes      | Number of candles (1–100000)                 |
+| format    | string   | no       | Response format override                     |
+
+### Rates from Position
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/rates/from-pos?symbol=EURUSD&timeframe=TIMEFRAME_H1&start_pos=0&count=100" \
+  | python -m json.tool
+```
+
+| Parameter | Type    | Required | Description                       |
+| --------- | ------- | -------- | --------------------------------- |
+| symbol    | str     | yes      | Symbol name                       |
+| timeframe | str/int | yes      | MT5 timeframe constant or integer |
+| start_pos | int     | yes      | Start position (0 = current bar)  |
+| count     | int     | yes      | Number of candles (1–100000)      |
+| format    | string  | no       | Response format override          |
+
+### Rates in Range
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/rates/range?symbol=EURUSD&timeframe=TIMEFRAME_H1&date_from=2024-01-01T00:00:00Z&date_to=2024-01-31T23:59:59Z" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Description                       |
+| --------- | -------- | -------- | --------------------------------- |
+| symbol    | string   | yes      | Symbol name                       |
+| timeframe | int/str  | yes      | MT5 timeframe constant or integer |
+| date_from | datetime | yes      | Start date (ISO 8601)             |
+| date_to   | datetime | yes      | End date (ISO 8601)               |
+| format    | string   | no       | Response format override          |
+
+### Ticks from Date
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/ticks/from?symbol=EURUSD&date_from=2024-01-02T10:00:00Z&count=500" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Default        | Description                       |
+| --------- | -------- | -------- | -------------- | --------------------------------- |
+| symbol    | string   | yes      |                | Symbol name                       |
+| date_from | datetime | yes      |                | Start date (ISO 8601)             |
+| count     | int      | yes      |                | Number of ticks (1–100000)        |
+| flags     | int/str  | no       | COPY_TICKS_ALL | MT5 tick flag constant or integer |
+| format    | string   | no       |                | Response format override          |
+
+### Ticks in Range
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/ticks/range?symbol=EURUSD&date_from=2024-01-02T10:00:00Z&date_to=2024-01-02T11:00:00Z" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Default        | Description                       |
+| --------- | -------- | -------- | -------------- | --------------------------------- |
+| symbol    | string   | yes      |                | Symbol name                       |
+| date_from | datetime | yes      |                | Start date (ISO 8601)             |
+| date_to   | datetime | yes      |                | End date (ISO 8601)               |
+| flags     | int/str  | no       | COPY_TICKS_ALL | MT5 tick flag constant or integer |
+| format    | string   | no       |                | Response format override          |
+
+### Market Book (DOM)
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/market-book/EURUSD" | python -m json.tool
+```
+
+If this returns `503`, explain that MT5 did not provide DOM data for the
+requested symbol and include the server's error text.
+
+---
+
+## Positions, Orders & History
+
+### Open Positions
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/positions" | python -m json.tool
+```
+
+| Parameter | Type   | Required | Description               |
+| --------- | ------ | -------- | ------------------------- |
+| symbol    | string | no       | Filter by symbol          |
+| group     | string | no       | Filter by group pattern   |
+| ticket    | int    | no       | Filter by position ticket |
+| format    | string | no       | Response format override  |
+
+### Pending Orders
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/orders" | python -m json.tool
+```
+
+| Parameter | Type   | Required | Description              |
+| --------- | ------ | -------- | ------------------------ |
+| symbol    | string | no       | Filter by symbol         |
+| group     | string | no       | Filter by group pattern  |
+| ticket    | int    | no       | Filter by order ticket   |
+| format    | string | no       | Response format override |
+
+### Historical Orders
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/history/orders?date_from=2024-01-01T00:00:00Z&date_to=2024-01-31T23:59:59Z" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Description                                       |
+| --------- | -------- | -------- | ------------------------------------------------- |
+| date_from | datetime | cond.    | Start date (required if no ticket/position)       |
+| date_to   | datetime | cond.    | End date (required if no ticket/position)         |
+| ticket    | int      | cond.    | Filter by ticket (alternative to date range)      |
+| position  | int      | cond.    | Filter by position ID (alternative to date range) |
+| symbol    | string   | no       | Filter by symbol                                  |
+| group     | string   | no       | Filter by group pattern                           |
+| format    | string   | no       | Response format override                          |
+
+Either `(date_from AND date_to)` or `(ticket OR position)` must be provided.
+
+### Historical Deals
+
+```bash
+curl -s "${AUTH_HEADER[@]}" \
+  "${MT5API_URL}/history/deals?date_from=2024-01-01T00:00:00Z&date_to=2024-01-31T23:59:59Z" \
+  | python -m json.tool
+```
+
+| Parameter | Type     | Required | Description                                       |
+| --------- | -------- | -------- | ------------------------------------------------- |
+| date_from | datetime | cond.    | Start date (required if no ticket/position)       |
+| date_to   | datetime | cond.    | End date (required if no ticket/position)         |
+| ticket    | int      | cond.    | Filter by ticket (alternative to date range)      |
+| position  | int      | cond.    | Filter by position ID (alternative to date range) |
+| symbol    | string   | no       | Filter by symbol                                  |
+| group     | string   | no       | Filter by group pattern                           |
+| format    | string   | no       | Response format override                          |
+
+Either `(date_from AND date_to)` or `(ticket OR position)` must be provided.
+
+---
+
+## Procedure
+
+1. Identify which endpoint(s) the user needs from the sections above.
+2. Gather required parameters (symbol, timeframe, dates, count, filters).
+3. Decide whether the caller needs JSON or Parquet output.
+4. Build `AUTH_HEADER` only when `MT5API_SECRET_KEY` is set, then construct and run
+   the appropriate `curl` command(s).
+5. For `ticks/range`, start with a narrow interval and widen only if needed.
+6. Parse the JSON response and summarize the results, or note when the API
+   returned Parquet data.
+7. If `/market-book/{symbol}` returns `503`, explain that MT5 did not provide
+   DOM data for that symbol and include the error text.
+8. If the health status is `unhealthy`, note that the MT5 terminal may not be
+   running or reachable.
+9. For historical queries, remind the user that either a date range or a
+   ticket/position filter is required.

mt5api-0.0.4/AGENTS.md

@@ -0,0 +1,90 @@
+# Repository Guidelines
+
+## Commands
+
+### Development Setup
+
+- `uv sync --dev` installs runtime and development dependencies.
+- `uv run uvicorn mt5api.main:app --host 0.0.0.0 --port 8000` starts the API locally.
+- `uv run python -m mt5api` starts the app using `MT5API_HOST`, `MT5API_PORT`, and `MT5API_LOG_LEVEL`.
+- `uv run mkdocs serve` previews the documentation site.
+
+### Code Quality and Documentation
+
+**Important**: Run these before committing or creating a PR.
+
+1. **Format, lint, and test**: Use `local-qa` skill.
+2. **Documentation build**: Run `uv run mkdocs build` when documentation, configuration, or OpenAPI-visible behavior changes.
+
+## Architecture
+
+### Runtime Constraints
+
+- The API server must run on Windows with a logged-in MetaTrader 5 terminal.
+- Linux and macOS are for HTTP clients, documentation work, and local non-runtime development only.
+
+### Key Dependencies
+
+- `pdmt5`: Underlying MetaTrader 5 client integration used by the API layer.
+- `fastapi`: HTTP application framework and OpenAPI generation.
+
+### Package Structure
+
+- `mt5api/`: Main FastAPI package.
+  - `main.py`: App wiring, lifespan handling, middleware, CORS, and router registration.
+  - `__main__.py`: CLI entry point for launching the API from environment-backed configuration.
+  - `config.py`: Environment-backed configuration normalization and validation.
+  - `auth.py`: Optional API key authentication helpers.
+  - `dependencies.py`: Shared endpoint dependencies and MT5 accessors.
+  - `formatters.py`: JSON and Parquet response formatting helpers.
+  - `models.py`: Pydantic API models.
+  - `middleware.py`: Request logging and error handling.
+  - `constants.py`: Shared constants and environment variable names.
+  - `routers/`: Endpoint groups for operations: `health.py`, `symbols.py`, `market.py`, `account.py`, `history.py`, `calc.py`, and `trading.py`.
+- `tests/`: Pytest suite covering API behavior, configuration, middleware, and CLI entry points.
+- `docs/`: MkDocs documentation, including REST API and deployment guidance.
+
+## Quality Standards
+
+- Type hints required (pyright strict mode)
+- Comprehensive linting with 35+ rule categories (ruff)
+- Test coverage tracking with 100% (pytest-cov)
+- Parametrized tests for input/result matrices using `pytest.mark.parametrize` (pytest)
+
+## Documentation Workflow
+
+1. Update docstrings and docs when behavior, configuration, or OpenAPI-visible output changes.
+2. Local preview: `uv run mkdocs serve`
+3. Build validation: `uv run mkdocs build`
+
+## Commit & Pull Request Guidelines
+
+- Run QA using `local-qa` skill before committing or creating a PR.
+- Branch names use appropriate prefixes on creation (e.g., `feature/...`, `bugfix/...`, `refactor/...`, `docs/...`, `chore/...`).
+- When instructed to create a PR, create it as a draft with appropriate labels by default.
+
+## Security & Configuration Tips
+
+- Do not commit real MT5 credentials or API keys.
+- Configure `MT5API_SECRET_KEY`, `MT5API_RATE_LIMIT`, `MT5API_CORS_ORIGINS`, `MT5API_ROUTER_PREFIX`, and `MT5API_LOG_LEVEL` through environment variables.
+- Keep runtime configuration in the environment instead of hardcoding deployment values.
+- Authentication mode is fixed at process startup; cover both authenticated and unauthenticated behavior when changing auth-related code.
+
+## Code Design Principles
+
+Always prefer the simplest design that works.
+
+- **KISS**: Choose straightforward solutions and avoid unnecessary abstraction.
+- **DRY**: Remove duplication when it improves clarity and maintainability.
+- **YAGNI**: Do not add features, hooks, or flexibility until they are needed.
+- **SOLID/Clean Code**: Apply these as tools only when they keep the design simpler and easier to change.
+
+## Development Methodology
+
+Keep delivery incremental, test-backed, and easy to review.
+
+- Make small, safe, reversible changes.
+- Prefer `Red -> Green -> Refactor`.
+- Do not mix feature work and refactoring in the same commit.
+- Refactor when it improves clarity or removes real duplication (Rule of Three).
+- Keep tests fast, focused, and self-validating.

mt5api-0.0.4/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: mt5api
+Version: 0.0.4
+Summary: MetaTrader 5 REST API
+Project-URL: Repository, https://github.com/dceoy/mt5api.git
+Author-email: dceoy <dceoy@users.noreply.github.com>
+Maintainer-email: dceoy <dceoy@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: pyarrow>=18.0.0
+Requires-Dist: python-jose[cryptography]>=3.3.0
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: slowapi>=0.1.9
+Requires-Dist: uvicorn[standard]>=0.32.0
+Description-Content-Type: text/markdown
+
+# mt5api
+
+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, 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.
+
+## Architecture
+
+```mermaid
+graph TB
+    Client["HTTP Client<br/>(Any OS)"]
+
+    subgraph "Windows Host"
+        subgraph "FastAPI Application"
+            Middleware["Middleware Stack<br/>CORS · Logging · Error Handler · Rate Limiter"]
+            Routers["Routers<br/>health · symbols · market · account · history · calc · trading"]
+            Auth["API Key Security Dependency<br/>Security(api_key_header) · verify_api_key"]
+            Deps["FastAPI Dependencies<br/>MT5 Client Singleton · Format Negotiation"]
+            Formatters["Response Formatters<br/>JSON · Parquet"]
+            Middleware --> Routers --> Deps --> Formatters
+            Auth -.-> Routers
+            Formatters --> Middleware
+        end
+
+        Deps --> pdmt5["pdmt5<br/>MT5 Client Library"]
+        pdmt5 --> MT5["MetaTrader 5<br/>Terminal"]
+    end
+
+    Client -- "HTTP/REST" --> Middleware
+    Middleware -- "JSON / Parquet" --> Client
+```
+
+## Features
+
+- REST endpoints for symbols, market data, account info, orders, history,
+  calculations, and trading operations
+- 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.
+
+```powershell
+git clone https://github.com/dceoy/mt5api.git
+cd mt5api
+uv sync
+```
+
+## Running the API on Windows
+
+```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
+```
+
+Docs:
+
+- Swagger UI: `http://localhost:8000/docs`
+- OpenAPI JSON: `http://localhost:8000/openapi.json`
+
+Set `MT5API_ROUTER_PREFIX` to mount the API endpoints under a shared path such
+as `/api/v1`. The default is `""`, which keeps routes like `/health` and
+`/symbols` at the root. `"/api/v1"`, `"api/v1"`, and `"/api/v1/"` are treated
+the same.
+
+Set `MT5API_MAX_MARKET_BOOK_SUBSCRIPTIONS` to cap active market-book
+subscriptions. The default limit is `100`.
+
+## 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`.
+
+```console
+curl "http://windows-host:8000/health"
+```
+
+```console
+# Include X-API-Key only when MT5API_SECRET_KEY is configured on the server.
+curl -H "X-API-Key: your-secret-api-key" "http://windows-host:8000/symbols?group=*USD*"
+```
+
+```console
+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.
+
+## Endpoints
+
+If `MT5API_ROUTER_PREFIX` is set, prepend that value to every API route below.
+
+### Read-Only Endpoints
+
+- Health: `GET /health`, `GET /version`, `GET /last-error`
+- Symbols: `GET /symbols`, `GET /symbols/total`, `GET /symbols/{symbol}`,
+  `GET /symbols/{symbol}/tick`
+- Market data: `GET /rates/from`, `GET /rates/from-pos`, `GET /rates/range`,
+  `GET /ticks/from`, `GET /ticks/range`, `GET /market-book/{symbol}`
+- Calculations: `GET /calc/margin`, `GET /calc/profit`
+- Account: `GET /account`, `GET /terminal`
+- Trading state: `GET /positions`, `GET /positions/total`,
+  `GET /orders`, `GET /orders/total`
+- History: `GET /history/orders`, `GET /history/orders/total`,
+  `GET /history/deals`, `GET /history/deals/total`
+
+### Operational Endpoints
+
+- `POST /symbols/{symbol}/select` — Show or hide symbol in MarketWatch
+- `POST /market-book/{symbol}/subscribe` — Subscribe to DOM events
+- `POST /market-book/{symbol}/unsubscribe` — Unsubscribe from DOM events
+- `POST /order/check` — Validate a trade request without execution
+
+## License
+
+MIT License - see [LICENSE](https://github.com/dceoy/mt5api/blob/main/LICENSE).