gavindiaz/aiomql
1
0
Fork 0
mirror of https://github.com/Ichinga-Samuel/aiomql.git synced 2026-08-17 05:48:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

3.0.4

Browse Source
This commit is contained in:
Ichinga Samuel
2023-10-16 15:36:31 +01:00
parent 027f9fd8de
commit e285610fe5
22 changed files with 849 additions and 817 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/terminal.md
+33 -50
View File
@@ -1,88 +1,71 @@
<a id="aiomql.terminal"></a>
# aiomql.terminal
## <a id="terminal"></a> Terminal
Terminal related functions and properties
<a id="aiomql.terminal.Terminal"></a>
## Terminal Objects
```python
class Terminal(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.
### Attributes:
|Name| Type | Description | Default |
|---|---------------------|------------------------------------------------|----|
|**initialized**|**bool** | check if initial request has been sent to the terminal to get terminal info. | False |
|**mt5**|**MetaTrader** | MetaTrader instance | None |
|**config**|**Config** | Config instance | None |
**Notes**:
Other attributes are defined in the TerminalInfo Class
<a id="aiomql.terminal.Terminal.initialize"></a>
#### initialize
### Notes:
Other attributes are defined in the TerminalInfo Class
### 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.
#### Returns:
|Type|Description|
|---|---|
|**bool**|True if successful else False|
**Returns**:
- `bool` - True if successful else False
<a id="aiomql.terminal.Terminal.version"></a>
#### version
### 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
**Returns**:
#### Returns:
|Type|Description|
|---|---|
|**Version**|version of tuple as Version object|
- `Version` - version of tuple as Version object
**Raises**:
- `ValueError` - If the terminal version cannot be obtained
<a id="aiomql.terminal.Terminal.info"></a>
#### info
#### Raises:
|Exception|Description|
|---|---|
|**ValueError**|If the terminal version cannot be obtained|
### 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**:
- `Terminal` - Terminal status and settings as a terminal object.
<a id="aiomql.terminal.Terminal.symbols_total"></a>
#### symbols\_total
#### Returns:
|Type|Description|
|---|---|
|**TerminalInfo**|Terminal status and settings as a terminal object.|
### symbols\_total
```python
async def symbols_total() -> int
```
Get the number of all financial instruments in the MetaTrader 5 terminal.
**Returns**:
- `int` - Total number of available symbols
#### Returns:
|Type|Description|
|---|---|
|**int**|Total number of available symbols|