gavindiaz/aiomql
1
0
Fork 0
mirror of https://github.com/Ichinga-Samuel/aiomql.git synced 2026-08-25 01:38:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

v4.0.17 no-backtest

Browse Source
This commit is contained in:
Ichinga Samuel
2026-02-21 07:43:33 +01:00
parent 844e39194b
commit 97aea6952e
124 changed files with 8198 additions and 14349 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lib/terminal.md
+18 -72
View File
@@ -1,84 +1,30 @@
# Terminal
# terminal
## Table of Contents
- [Terminal](#terminal.terminal)
- [initialize](#terminal.initialize)
- [version](#terminal.version)
- [info](#terminal.info)
- [symbols_total](#terminal.symbols_total)
`aiomql.lib.terminal` — Terminal information retrieval.
<a id="terminal.terminal"></a>
### Terminal
```python
class Terminal(_Base, TerminalInfo)
```
Terminal Class. Get information about the MetaTrader 5 terminal. The class is a subclass of the TerminalInfo
class. It inherits all the attributes and methods of the TerminalInfo class and adds some useful methods.
## Overview
#### Attributes:
| Name | Type | Description | Default |
|-----------|--------------|-------------------------------|---------|
| `version` | `Version` | MetaTrader5 Terminal Version. | None |
The `Terminal` class retrieves information about the MetaTrader 5 terminal, such as its
version, connection status, and data paths.
Inherits from [`_Base`](../core/base.md).
<a id="terminal.initialize"></a>
### initialize
```python
async def initialize() -> bool
```
Establish a connection with the MetaTrader 5 terminal. There are three call options. Call without parameters.
The terminal for connection is found automatically. Call specifying the path to the MetaTrader 5 terminal we
want to connect to. word path as a keyword argument Call specifying the trading account path and parameters
i.e. login, password, server, as keyword arguments, path can be omitted.
## Classes
#### Returns:
| Type | Description |
|--------|-------------------------------|
| `bool` | True if successful else False |
### `Terminal`
> Retrieves MetaTrader 5 terminal details.
<a id="terminal.version"></a>
### version
```python
async def version()
```
Get the MetaTrader 5 terminal version. This method returns the terminal version, build and release date as
a tuple of three values
All `TerminalInfo` fields (e.g. `connected`, `trade_allowed`, `name`, `path`, `build`)
are available as instance attributes after initialisation.
#### Returns:
| Type | Description |
|-----------|------------------------------------|
| `Version` | version of tuple as Version object |
#### Methods
#### Raises:
| Exception | Description |
|--------------|--------------------------------------------|
| `ValueError` | If the terminal version cannot be obtained |
| Method | Returns | Description |
|--------|---------|-------------|
| `info()` | `TerminalInfo \| None` | Fetches and caches terminal info |
| `version()` | `tuple[int, int, str] \| None` | Terminal version |
## Synchronous API
<a id="terminal.info"></a>
### info
```python
async def info()
```
Get the connected MetaTrader 5 client terminal status and settings. gets terminal info in the form of a
named tuple structure (namedtuple). Return None in case of an error. The info on the error can be
obtained using last_error().
#### Returns:
| Type | Description |
|----------------|----------------------------------------------------|
| `TerminalInfo` | Terminal status and settings as a terminal object. |
<a id="terminal.symbols_total"></a>
### symbols_total
```python
async def symbols_total() -> int
```
Get the number of all financial instruments in the MetaTrader 5 terminal.
#### Returns:
| Type | Description |
|-------|-----------------------------------|
| `int` | Total number of available symbols |
Available in `aiomql.lib.sync.terminal`.