Files

31 lines
766 B
Markdown
Raw Permalink Normal View History

2026-02-21 07:43:33 +01:00
# terminal
2023-10-11 09:49:06 +01:00
2026-02-21 07:43:33 +01:00
`aiomql.lib.terminal` — Terminal information retrieval.
2024-02-12 21:09:28 +01:00
2026-02-21 07:43:33 +01:00
## Overview
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
The `Terminal` class retrieves information about the MetaTrader 5 terminal, such as its
version, connection status, and data paths.
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
Inherits from [`_Base`](../core/base.md).
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
## Classes
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
### `Terminal`
2023-10-11 09:49:06 +01:00
2026-02-21 07:43:33 +01:00
> Retrieves MetaTrader 5 terminal details.
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
All `TerminalInfo` fields (e.g. `connected`, `trade_allowed`, `name`, `path`, `build`)
are available as instance attributes after initialisation.
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
#### Methods
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
| Method | Returns | Description |
|--------|---------|-------------|
| `info()` | `TerminalInfo \| None` | Fetches and caches terminal info |
| `version()` | `tuple[int, int, str] \| None` | Terminal version |
2023-10-11 09:49:06 +01:00
2026-02-21 07:43:33 +01:00
## Synchronous API
2024-11-10 12:25:50 +01:00
2026-02-21 07:43:33 +01:00
Available in `aiomql.lib.sync.terminal`.