mirror of
https://github.com/Ichinga-Samuel/aiomql.git
synced 2026-08-09 18:20:58 +00:00
Ichinga Samuel
623 lines
21 KiB
Markdown
623 lines
21 KiB
Markdown
* [MetaTrader](#MetaTrader)
|
|
* [\_\_aenter\_\_](#MetaTrader.__aenter__)
|
|
* [\_\_aexit\_\_](#MetaTrader.__aexit__)
|
|
* [login](#MetaTrader.login)
|
|
* [initialize](#MetaTrader.initialize)
|
|
* [shutdown](#MetaTrader.shutdown)
|
|
* [version](#MetaTrader.version)
|
|
* [account\_info](#MetaTrader.account_info)
|
|
* [terminal\_info](#MetaTrader.terminal_info)
|
|
* [last\_error](#MetaTrader.last_error)
|
|
* [symbols\_total](#MetaTrader.symbols_total)
|
|
* [symbols\_get](#MetaTrader.symbols_get)
|
|
* [symbol\_info](#MetaTrader.symbol_info)
|
|
* [symbol\_info\_tick](#MetaTrader.symbol_info_tick)
|
|
* [symbol\_select](#MetaTrader.symbol_select)
|
|
* [market\_book\_add](#MetaTrader.market_book_add)
|
|
* [market\_book\_get](#MetaTrader.market_book_get)
|
|
* [market\_book\_release](#MetaTrader.market_book_release)
|
|
* [copy\_rates\_from](#MetaTrader.copy_rates_from)
|
|
* [copy\_rates\_from\_pos](#MetaTrader.copy_rates_from_pos)
|
|
* [copy\_rates\_range](#MetaTrader.copy_rates_range)
|
|
* [copy\_ticks\_from](#MetaTrader.copy_ticks_from)
|
|
* [copy\_ticks\_range](#MetaTrader.copy_ticks_range)
|
|
* [orders\_total](#MetaTrader.orders_total)
|
|
* [orders\_get](#MetaTrader.orders_get)
|
|
* [order\_calc\_margin](#MetaTrader.order_calc_margin)
|
|
* [order\_calc\_profit](#MetaTrader.order_calc_profit)
|
|
* [order\_check](#MetaTrader.order_check)
|
|
* [order\_send](#MetaTrader.order_send)
|
|
* [positions\_total](#MetaTrader.positions_total)
|
|
* [positions\_get](#MetaTrader.positions_get)
|
|
* [history\_orders\_total](#MetaTrader.history_orders_total)
|
|
* [history\_orders\_get](#MetaTrader.history_orders_get)
|
|
* [history\_deals\_total](#MetaTrader.history_deals_total)
|
|
* [history\_deals\_get](#MetaTrader.history_deals_get)
|
|
|
|
|
|
<a id="MetaTrader"></a>
|
|
### MetaTrader
|
|
```python
|
|
class MetaTrader(metaclass=BaseMeta)
|
|
```
|
|
The MetaTrader class is a wrapper around the MetaTrader terminal.
|
|
It provides methods for connecting to the MetaTrader terminal and retrieving data from it.
|
|
#### Attributes:
|
|
|Name|Type|Description|Default|
|
|
|---|---|---|---|
|
|
|error|Error|The last error encountered by the MetaTrader terminal.|Error(0, '')|
|
|
|
|
#### Notes:
|
|
All the attributes, enums and constants of the MetaTrader5 class are also available here. Although, they are more easily
|
|
accessible and used via the various enums and models defined in the module.
|
|
|
|
|
|
<a id="MetaTrader.__aenter__"></a>
|
|
#### \_\_aenter\_\_
|
|
```python
|
|
async def __aenter__() -> 'MetaTrader'
|
|
```
|
|
Async context manager entry point.
|
|
Initializes the connection to the MetaTrader terminal.
|
|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**MetaTrader**|An instance of the MetaTrader class|
|
|
|
|
<a id="MetaTrader.__aexit__"></a>
|
|
#### \_\_aexit\_\_
|
|
```python
|
|
async def __aexit__(exc_type, exc_val, exc_tb)
|
|
```
|
|
Async context manager exit point. Closes the connection to the MetaTrader terminal.
|
|
|
|
<a id="MetaTrader.login"></a>
|
|
#### login
|
|
```python
|
|
async def login(login: int,
|
|
password: str,
|
|
server: str,
|
|
timeout: int = 60000) -> bool
|
|
```
|
|
Connects to the MetaTrader terminal using the specified login, password and server.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**login**|**int**|The trading account number.|
|
|
|**password**|**str**|The trading account password.|
|
|
|**server**|**str**|The trading server name.|
|
|
|**timeout**|**int**|The timeout for the connection in seconds.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**bool**|True if successful, False otherwise.|
|
|
|
|
<a id="MetaTrader.initialize"></a>
|
|
#### initialize
|
|
```python
|
|
async def initialize(path: str = "",
|
|
login: int = 0,
|
|
password: str = "",
|
|
server: str = "",
|
|
timeout: int | None = None,
|
|
portable=False) -> bool
|
|
```
|
|
Initializes the connection to the MetaTrader terminal. All parameters are optional.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**path**|**str**|The path to the MetaTrader terminal executable.|
|
|
|**login**|**int**|The trading account number.|
|
|
|**password**|**str**|The trading account password.|
|
|
|**server**|**str**|The trading server name.|
|
|
|**timeout**|**int** or **None**|The timeout for the connection in seconds.|
|
|
|**portable**|**bool**|If True, the terminal will be launched in portable mode.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**bool**|True if successful, False otherwise.|
|
|
|
|
<a id="MetaTrader.shutdown"></a>
|
|
#### shutdown
|
|
```python
|
|
async def shutdown() -> None
|
|
```
|
|
Closes the connection to the MetaTrader terminal.
|
|
|
|
<a id="MetaTrader.version"></a>
|
|
#### version
|
|
```python
|
|
async def version() -> tuple[int, int, str] | None
|
|
```
|
|
Returns the version of the MetaTrader terminal.
|
|
#### Returns:
|
|
|Type| Description |
|
|
|---|-----------------------------------------------------------------------------------------------------|
|
|
|**tuple[int, int, str]**| A tuple of the MetaTrader terminal version. **Terminal Version**, **Build**, **Build Release Date** |
|
|
|
|
<a id="MetaTrader.account_info"></a>
|
|
#### account\_info
|
|
```python
|
|
async def account_info() -> AccountInfo | None
|
|
```
|
|
Returns the account information for the connected account.
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**AccountInfo**|An instance of the AccountInfo class|
|
|
|
|
<a id="MetaTrader.terminal_info"></a>
|
|
#### terminal\_info
|
|
```python
|
|
async def terminal_info() -> TerminalInfo | None
|
|
```
|
|
Returns the terminal information for the connected terminal.
|
|
#### Returns:
|
|
|Type| Description |
|
|
|---|------------------------------------------------|
|
|
|**TerminalInfo**| An instance of the TerminalInfo class. A tuple |
|
|
|
|
<a id="MetaTrader.last_error"></a>
|
|
#### last\_error
|
|
```python
|
|
async def last_error() -> tuple[int, str]
|
|
```
|
|
Returns the last error code and description.
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[int, str]**|A tuple of the last error code and description.|
|
|
|
|
<a id="MetaTrader.symbols_total"></a>
|
|
#### symbols\_total
|
|
```python
|
|
async def symbols_total() -> int
|
|
```
|
|
Returns the total number of symbols.
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**int**|The total number of symbols.|
|
|
|
|
<a id="MetaTrader.symbols_get"></a>
|
|
#### symbols\_get
|
|
```python
|
|
async def symbols_get(group: str = "") -> tuple[SymbolInfo] | None
|
|
```
|
|
Returns the symbol information for all symbols or for a specified group.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**group**|**str**|The group name. Optional named parameter. If the group is specified, the function returns only symbols meeting a specified criteria for a symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[SymbolInfo]**|A tuple of SymbolInfo objects.|
|
|
|
|
|
|
<a id="MetaTrader.symbol_info"></a>
|
|
#### symbol\_info
|
|
```python
|
|
async def symbol_info(symbol: str) -> SymbolInfo | None
|
|
```
|
|
Returns the symbol information for the specified symbol.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**SymbolInfo**|An instance of the SymbolInfo class.|
|
|
|
|
<a id="MetaTrader.symbol_info_tick"></a>
|
|
#### symbol\_info\_tick
|
|
```python
|
|
async def symbol_info_tick(symbol: str) -> Tick | None
|
|
```
|
|
Returns the latest tick for the specified symbol.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**Tick**|An instance of the Tick class.|
|
|
|
|
<a id="MetaTrader.symbol_select"></a>
|
|
#### symbol\_select
|
|
```python
|
|
async def symbol_select(symbol: str, enable: bool) -> bool
|
|
```
|
|
Selects or unselects the specified symbol in the Market Watch window.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**enable**|**bool**|If True, the symbol will be selected. If False, the symbol will be unselected.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**bool**|True if successful, False otherwise.|
|
|
|
|
<a id="MetaTrader.market_book_add"></a>
|
|
#### market\_book\_add
|
|
```python
|
|
async def market_book_add(symbol: str) -> bool
|
|
```
|
|
Adds the specified symbol to the market book.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**bool**|True if successful, False otherwise.|
|
|
|
|
|
|
<a id="MetaTrader.market_book_get"></a>
|
|
#### market\_book\_get
|
|
```python
|
|
async def market_book_get(symbol: str) -> tuple[BookInfo] | None
|
|
```
|
|
Returns the market depth for the specified symbol.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[BookInfo]**|A tuple of BookInfo objects.|
|
|
|
|
<a id="MetaTrader.market_book_release"></a>
|
|
#### market\_book\_release
|
|
```python
|
|
async def market_book_release(symbol: str) -> bool
|
|
```
|
|
Removes the specified symbol from the market book.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**bool**|True if successful, False otherwise.|
|
|
|
|
<a id="MetaTrader.copy_rates_from"></a>
|
|
#### copy\_rates\_from
|
|
|
|
```python
|
|
import numpy
|
|
|
|
|
|
async def copy_rates_from(symbol: str,
|
|
timeframe: TimeFrame,
|
|
date_from: datetime | int,
|
|
count: int) -> numpy.ndarray | None
|
|
```
|
|
Returns the OHLCV rates for the specified symbol and timeframe starting from the specified date.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**timeframe**|**TimeFrame**|The timeframe.|
|
|
|**date_from**|**datetime** or **int**|The date to start from.|
|
|
|**count**|**int**|The number of rates to return.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**numpy.ndarray**|A numpy array of OHLCV rates.|
|
|
|
|
<a id="MetaTrader.copy_rates_from_pos"></a>
|
|
#### copy\_rates\_from\_pos
|
|
```python
|
|
async def copy_rates_from_pos(symbol: str,
|
|
timeframe: TimeFrame,
|
|
start_pos: int,
|
|
count: int) -> numpy.ndarray | None
|
|
```
|
|
Returns the OHLCV rates for the specified symbol and timeframe starting from the specified position.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**timeframe**|**TimeFrame**|The timeframe.|
|
|
|**start_pos**|**int**|The position to start from.|
|
|
|**count**|**int**|The number of rates to return.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**numpy.ndarray**|A numpy array of OHLCV rates.|
|
|
|
|
<a id="MetaTrader.copy_rates_range"></a>
|
|
#### copy\_rates\_range
|
|
```python
|
|
async def copy_rates_range(symbol: str,
|
|
timeframe: TimeFrame,
|
|
date_from: datetime | int,
|
|
date_to: datetime | int) -> numpy.ndarray | None
|
|
```
|
|
Returns the OHLCV rates for the specified symbol and timeframe between the specified dates.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**timeframe**|**TimeFrame**|The timeframe.|
|
|
|**date_from**|**datetime** or **int**|The start date.|
|
|
|**date_to**|**datetime** or **int**|The end date.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**numpy.ndarray**|A numpy array of OHLCV rates.|
|
|
|
|
<a id="MetaTrader.copy_ticks_from"></a>
|
|
#### copy\_ticks\_from
|
|
```python
|
|
async def copy_ticks_from(symbol: str,
|
|
date_from: datetime | int,
|
|
count: int,
|
|
flags: CopyTicks) -> tuple[Tick] | None
|
|
```
|
|
Returns the ticks for the specified symbol starting from the specified date.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**date_from**|**datetime** or **int**|The date to start from.|
|
|
|**count**|**int**|The number of ticks to return.|
|
|
|**flags**|**CopyTicks**|The CopyTicks flags.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[Tick]**|A tuple of Tick objects.|
|
|
|
|
<a id="MetaTrader.copy_ticks_range"></a>
|
|
#### copy\_ticks\_range
|
|
```python
|
|
async def copy_ticks_range(symbol: str,
|
|
date_from: datetime | int,
|
|
date_to: datetime | int,
|
|
flags: CopyTicks) -> tuple[Tick] | None
|
|
```
|
|
Returns the ticks for the specified symbol between the specified dates.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**date_from**|**datetime** or **int**|The start date.|
|
|
|**date_to**|**datetime** or **int**|The end date.|
|
|
|**flags**|**CopyTicks**|The CopyTicks flags.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[Tick]**|A tuple of Tick objects.|
|
|
|
|
<a id="MetaTrader.orders_total"></a>
|
|
#### orders\_total
|
|
```python
|
|
async def orders_total() -> int
|
|
```
|
|
Returns the total number of active orders.
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**int**|The total number of active orders.|
|
|
|
|
<a id="MetaTrader.orders_get"></a>
|
|
#### orders\_get
|
|
```python
|
|
async def orders_get(group: str = "",
|
|
ticket: int = 0,
|
|
symbol: str = "") -> tuple[TradeOrder] | None
|
|
```
|
|
Get active orders with the ability to filter by symbol or ticket. There are three call options.
|
|
Call without parameters. Return active orders on all symbols
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**group**|**str**|The filter for arranging a group of necessary symbols. Optional named parameter. If the group is specified, the function returns only active orders meeting a specified criteria for a symbol name.|
|
|
|**ticket**|**int**|Order ticket (ORDER_TICKET). Optional named parameter.|
|
|
|**symbol**|**str**|Symbol name. Optional named parameter. If a symbol is specified, the ticket parameter is ignored.|
|
|
#### Returns:
|
|
| Type | Description |
|
|
|-----------------------|------------------------------------------------------|
|
|
| **tuple[TradeOrder]** | A tuple of active trade orders as TradeOrder objects |
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**tuple[TradeOrder]**|A tuple of active trade orders as TradeOrder objects|
|
|
|
|
<a id="MetaTrader.order_calc_margin"></a>
|
|
#### order\_calc\_margin
|
|
```python
|
|
async def order_calc_margin(action: OrderType,
|
|
symbol: str,
|
|
volume: float,
|
|
price: float) -> float | None
|
|
```
|
|
Calculates the margin required to open a trade.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**action**|**OrderType**|The order type.|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**volume**|**float**|The order volume.|
|
|
|**price**|**float**|The order price.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**float**|The margin required to open a trade.|
|
|
|
|
<a id="MetaTrader.order_calc_profit"></a>
|
|
#### order\_calc\_profit
|
|
```python
|
|
async def order_calc_profit(action: OrderType,
|
|
symbol: str,
|
|
volume: float,
|
|
price_open: float,
|
|
price_close: float) -> float | None
|
|
```
|
|
Calculates the profit for a closed trade.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**action**|**OrderType**|The order type.|
|
|
|**symbol**|**str**|The symbol name.|
|
|
|**volume**|**float**|The order volume.|
|
|
|**price_open**|**float**|The order open price.|
|
|
|**price_close**|**float**|The order close price.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**float**|The profit for a closed trade.|
|
|
|
|
<a id="MetaTrader.order_check"></a>
|
|
#### order\_check
|
|
```python
|
|
async def order_check(request: dict) -> OrderCheckResult
|
|
```
|
|
Checks the specified order for validity.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**request**|**dict**|The order request.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**OrderCheckResult**|An instance of the OrderCheckResult class.|
|
|
|
|
<a id="MetaTrader.order_send"></a>
|
|
#### order\_send
|
|
```python
|
|
async def order_send(request: dict) -> OrderSendResult
|
|
```
|
|
Sends the specified order request to the MetaTrader terminal.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**request**|**dict**|The order request.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**OrderSendResult**|An instance of the OrderSendResult class.|
|
|
|
|
<a id="MetaTrader.positions_total"></a>
|
|
#### positions\_total
|
|
```python
|
|
async def positions_total() -> int
|
|
```
|
|
Returns the total number of open positions.
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**int**|The total number of open positions.|
|
|
|
|
|
|
<a id="MetaTrader.positions_get"></a>
|
|
#### positions\_get
|
|
```python
|
|
async def positions_get(group: str = "",
|
|
ticket: int = 0,
|
|
symbol: str = "") -> tuple[TradePosition] | None
|
|
```
|
|
Returns the open positions with the ability to filter by symbol or ticket. There are three call options.
|
|
Call without parameters. Return open positions on all symbols
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**group**|**str**|The filter for arranging a group of necessary symbols. Optional named parameter. If the group is specified, the function returns only open positions meeting a specified criteria for a symbol name.|
|
|
|**ticket**|**int**|Position ticket (POSITION_TICKET). Optional named parameter.|
|
|
|**symbol**|**str**|Symbol name. Optional named parameter. If a symbol is specified, the ticket parameter is ignored.|
|
|
#### Returns:
|
|
| Type | Description |
|
|
|----------------------------|---------------------------------------------------------|
|
|
| **tuple[TradePosition]** | A tuple of open trade positions as TradePosition objects |
|
|
|
|
<a id="MetaTrader.history_orders_total"></a>
|
|
#### history\_orders\_total
|
|
```python
|
|
async def history_orders_total(date_from: datetime | int,
|
|
date_to: datetime | int) -> int
|
|
```
|
|
Returns the total number of closed orders for the specified period.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**date_from**|**datetime** or **int**|The start date.|
|
|
|**date_to**|**datetime** or **int**|The end date.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**int**|The total number of closed orders for the specified period.|
|
|
|
|
|
|
<a id="MetaTrader.history_orders_get"></a>
|
|
#### history\_orders\_get
|
|
```python
|
|
async def history_orders_get(date_from: datetime | int = None,
|
|
date_to: datetime | int = None,
|
|
group: str = "",
|
|
ticket: int = 0,
|
|
position: int = 0) -> tuple[TradeOrder] | None
|
|
```
|
|
Returns the closed orders for the specified period with the ability to filter by symbol or ticket. There are three call options.
|
|
Call without parameters. Return closed orders on all symbols
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**date_from**|**datetime** or **int**|The start date. Optional named parameter.|
|
|
|**date_to**|**datetime** or **int**|The end date. Optional named parameter.|
|
|
|**group**|**str**|The filter for arranging a group of necessary symbols. Optional named parameter. If the group is specified, the function returns only closed orders meeting a specified criteria for a symbol name.|
|
|
|**ticket**|**int**|Order ticket (ORDER_TICKET). Optional named parameter.|
|
|
|**position**|**int**|Position ticket (POSITION_TICKET). Optional named parameter.|
|
|
#### Returns:
|
|
| Type | Description |
|
|
|----------------------------|---------------------------------------------------------|
|
|
| **tuple[TradeOrder]** | A tuple of closed trade orders as TradeOrder objects |
|
|
|
|
<a id="MetaTrader.history_deals_total"></a>
|
|
#### history\_deals\_total
|
|
```python
|
|
async def history_deals_total(date_from: datetime | int,
|
|
date_to: datetime | int) -> int
|
|
```
|
|
Returns the total number of closed deals for the specified period.
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**date_from**|**datetime** or **int**|The start date.|
|
|
|**date_to**|**datetime** or **int**|The end date.|
|
|
#### Returns:
|
|
|Type|Description|
|
|
|---|---|
|
|
|**int**|The total number of closed deals for the specified period.|
|
|
|
|
|
|
<a id="MetaTrader.history_deals_get"></a>
|
|
#### history\_deals\_get
|
|
```python
|
|
async def history_deals_get(date_from: datetime | int = None,
|
|
date_to: datetime | int = None,
|
|
group: str = "",
|
|
ticket: int = 0,
|
|
position: int = 0) -> tuple[TradeDeal] | None
|
|
```
|
|
Returns the closed deals for the specified period with the ability to filter by symbol or ticket. There are three call options.
|
|
Call without parameters. Return closed deals on all symbols
|
|
#### Parameters:
|
|
|Name|Type|Description|
|
|
|---|---|---|
|
|
|**date_from**|**datetime** or **int**|The start date. Optional named parameter.|
|
|
|**date_to**|**datetime** or **int**|The end date. Optional named parameter.|
|
|
|**group**|**str**|The filter for arranging a group of necessary symbols. Optional named parameter. If the group is specified, the function returns only closed deals meeting a specified criteria for a symbol name.|
|
|
|**ticket**|**int**|Order ticket (ORDER_TICKET). Optional named parameter.|
|
|
|**position**|**int**|Position ticket (POSITION_TICKET). Optional named parameter.|
|
|
#### Returns:
|
|
| Type | Description |
|
|
|----------------------------|---------------------------------------------------------|
|
|
| **tuple[TradeDeal]** | A tuple of closed trade deals as TradeDeal objects | |