mirror of
https://github.com/Ichinga-Samuel/aiomql.git
synced 2026-08-25 17:48:06 +00:00
v4
This commit is contained in:
Ichinga Samuel
+73
-134
@@ -1,19 +1,17 @@
|
||||
# History
|
||||
|
||||
## Table of contents
|
||||
- [History](#history)
|
||||
- [\_\_init\_\_](#__init__)
|
||||
- [init](#init)
|
||||
- [get_deals](#get_deals)
|
||||
- [get_deals_ticket](#get_deals_ticket)
|
||||
- [get_deals_position](#get_deals_position)
|
||||
- [deals_total](#deals_total)
|
||||
- [get_orders](#get_orders)
|
||||
- [get_orders_position](#get_orders_position)
|
||||
- [get_order_ticket](#get_order_ticket)
|
||||
- [orders_total](#orders_total)
|
||||
- [History](#history.history)
|
||||
- [\_\_init\_\_](#history.__init__)
|
||||
- [initialize](#history.initialize)
|
||||
- [get_deals](#history.get_deals)
|
||||
- [get_deals_by_ticket](#history.get_deals_by_ticket)
|
||||
- [get_deals_by_position](#history.get_deals_by_position)
|
||||
- [get_orders](#history.get_orders)
|
||||
- [get_orders_by_position](#history.get_orders_by_position)
|
||||
- [get_orders_by_ticket](#history.get_orders_by_ticket)
|
||||
|
||||
<a id='history'></a>
|
||||
<a id='history.history'></a>
|
||||
### History
|
||||
```python
|
||||
class History
|
||||
@@ -27,170 +25,111 @@ The history class handles completed trade deals and trade orders in the trading
|
||||
| `total_deals` | `int` | Total number of deals | 0 |
|
||||
| `total_orders` | `int` | Total number orders | 0 |
|
||||
| `group` | `str` | Filter for selecting history by symbols. | "" |
|
||||
| `ticket` | `int` | Filter for selecting history by ticket number | 0 |
|
||||
| `position` | `int` | Filter for selecting history deals by position | 0 |
|
||||
| `initialized` | `bool` | check if initial request has been sent to the terminal to get history. | False |
|
||||
| `mt5` | `MetaTrader` | MetaTrader instance | None |
|
||||
| `config` | `Config` | Config instance | None |
|
||||
|
||||
|
||||
<a id='__init__'></a>
|
||||
<a id='history.__init__'></a>
|
||||
### \_\_init\_\_
|
||||
```python
|
||||
def __init__(*,
|
||||
date_from: datetime | float = 0,
|
||||
date_to: datetime | float = 0,
|
||||
group: str = "",
|
||||
ticket: int = 0,
|
||||
position: int = 0)
|
||||
def __init__(*, date_from: datetime | float, date_to: datetime | float, group: str = "")
|
||||
```
|
||||
#### Parameters
|
||||
|
||||
#### Parameters:
|
||||
| Name | Type | Description | Default |
|
||||
|-------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|
||||
| `date_from` | `datetime\|float` | Date the deals are requested from. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to twenty-four hours from the current time in 'utc' | 0 |
|
||||
| `date_to` | `datetime\|float` | Date up to which the deals are requested. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to the current time in "utc" | 0 |
|
||||
| `group` | `str` | Filter for selecting history by symbols. | "" |
|
||||
| `ticket` | `int` | Filter for selecting history by ticket number | 0 |
|
||||
| `position` | `int` | Filter for selecting history deals by position | 0 |
|
||||
|
||||
<a id='init'></a>
|
||||
### init
|
||||
<a id='history.initialize'></a>
|
||||
### initialize
|
||||
```python
|
||||
async def init(deals=True, orders=True) -> bool
|
||||
async def initialize() -> bool
|
||||
```
|
||||
Get history deals and orders
|
||||
#### Parameters
|
||||
| Name | Type | Description | Default |
|
||||
|----------|--------|---------------------------------------------------------------|---------|
|
||||
| `deals` | `bool` | If true get history deals during initial request to terminal | True |
|
||||
| `orders` | `bool` | If true get history orders during initial request to terminal | True |
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|--------|--------|-------------------------------------------------|---------|
|
||||
| `bool` | `bool` | True if all requests were successful else False | False |
|
||||
Get deals and orders within the timeframe specified in the constructor.
|
||||
|
||||
<a id='get_deals'></a>
|
||||
<a id='history.get_deals'></a>
|
||||
### get_deals
|
||||
```python
|
||||
async def get_deals(self, *, date_from: datetime | int = None, date_to: datetime | int = None, group: str = '',
|
||||
retries=3) -> list[TradeDeal]
|
||||
async def get_deals(self) -> tuple[TradeDeal, ...]
|
||||
```
|
||||
#### Parameters:
|
||||
| Name | Type | Description | Default |
|
||||
|-------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|
||||
| `date_from` | `datetime\|float` | Date the deals are requested from. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to twenty-four hours from the current time in 'utc' | None |
|
||||
| `date_to` | `datetime\|float` | Date up to which the deals are requested. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to the current time in "utc" | None |
|
||||
| `group` | `str` | Filter for selecting history by symbols. | "" |
|
||||
| `retries` | `int` | Number of retries if the request fails. | 3 |
|
||||
Get deals from trading history using the parameters set in the constructor.
|
||||
|
||||
#### Returns
|
||||
| Name | Type | Description |
|
||||
|---------|-------------------------|-----------------------|
|
||||
| `deals` | `tuple[TradeDeal, ...]` | A list of trade deals |
|
||||
|
||||
<a id='history.get_deals_by_ticket'></a>
|
||||
### get_deals_by_ticket
|
||||
```python
|
||||
def get_deals_by_ticket(self, *, ticket: int) -> tuple[TradeDeal, ...]
|
||||
```
|
||||
Get deals by ticket number. This filters deals by ticket based on the deals already fetched in initialize.
|
||||
|
||||
#### Parameters
|
||||
| Name | Type | Description |
|
||||
|----------|-------|----------------------|
|
||||
| `ticket` | `int` | Ticket number to get |
|
||||
|
||||
#### Returns:
|
||||
| Name | Type | Description | Default |
|
||||
|---------|--------------------|-----------------------|---------|
|
||||
| `deals` | `tuple[TradeDeal]` | A list of trade deals | [] |
|
||||
| Name | Type | Description |
|
||||
|---------|-------------------------|------------------------|
|
||||
| `deals` | `tuple[TradeDeal, ...]` | A tuple of trade deals |
|
||||
|
||||
<a id='get_deals_ticket'></a>
|
||||
### get_deals_ticket
|
||||
<a id='history.get_deals_by_position'></a>
|
||||
### get_deals_by_position
|
||||
```python
|
||||
async def get_deals_ticket(self, *, ticket: int) -> tuple[TradeDeal]
|
||||
```
|
||||
Get deals by ticket number
|
||||
#### Parameters:
|
||||
| Name | Type | Description | Default |
|
||||
|----------|------|-----------------------|---------|
|
||||
| `ticket` | `int`| Ticket number to get | 0 |
|
||||
|
||||
#### Returns:
|
||||
| Name | Type | Description | Default |
|
||||
|---------|--------------------|-----------------------|---------|
|
||||
| `deals` | `tuple[TradeDeal]` | A list of trade deals | [] |
|
||||
|
||||
<a id='get_deals_position'></a>
|
||||
### get_deals_position
|
||||
```python
|
||||
async def get_deals_position(self, *, position: int) -> list[TradeDeal]
|
||||
async def get_deals_by_position(self, *, position: int) -> tuple[TradeDeal, ...]
|
||||
```
|
||||
Get deals by position
|
||||
#### Parameters:
|
||||
| Name | Type | Description | Default |
|
||||
|------------|------|-----------------------|---------|
|
||||
| `position` | `int`| Position number to get | 0 |
|
||||
#### Parameters
|
||||
| Name | Type | Description |
|
||||
|------------|-------|------------------------|
|
||||
| `position` | `int` | Position number to get |
|
||||
|
||||
#### Returns:
|
||||
| Name | Type | Description | Default |
|
||||
|---------|--------------------|-----------------------|---------|
|
||||
| `deals` | `tuple[TradeDeal]` | A list of trade deals | [] |
|
||||
|
||||
|
||||
<a id='deals_total'></a>
|
||||
### deals_total
|
||||
```python
|
||||
async def deals_total() -> int
|
||||
```
|
||||
Get total number of deals within the specified period in the constructor.
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|---------------|-------|-----------------------|---------|
|
||||
| `total_deals` | `int` | Total number of deals | 0 |
|
||||
| Name | Type | Description |
|
||||
|---------|-------------------------|------------------------|
|
||||
| `deals` | `tuple[TradeDeal, ...]` | A tuple of trade deals |
|
||||
|
||||
<a id='get_orders'></a>
|
||||
<a id='history.get_orders'></a>
|
||||
### get_orders
|
||||
```python
|
||||
async def get_orders(self, *, date_from: datetime | int = None, date_to: datetime | int = None, group: str = '',
|
||||
retries=3) -> tuple[TradeOrder]
|
||||
async def get_orders(self) -> tuple[TradeOrder, ...]
|
||||
```
|
||||
Get orders from trading history using the parameters set in the constructor.
|
||||
|
||||
#### Parameters
|
||||
| Name | Type | Description | Default |
|
||||
|-------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|
||||
| `date_from` | `datetime\|float` | Date the deals are requested from. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to twenty-four hours from the current time in 'utc' | None |
|
||||
| `date_to` | `datetime\|float` | Date up to which the deals are requested. Set by the 'datetime' object or as a number of seconds elapsed since 1970.01.01. Defaults to the current time in "utc" | None |
|
||||
| `group` | `str` | Filter for selecting history by symbols. | "" |
|
||||
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|----------|---------------------|------------------------|---------|
|
||||
| `orders` | `tuple[TradeOrder]` | A list of trade orders | [] |
|
||||
|
||||
<a id='get_orders_position'></a>
|
||||
### get_orders_position
|
||||
<a id='history.get_orders_by_position'></a>
|
||||
### get_orders_by_position
|
||||
```python
|
||||
async def get_orders_position(self, *, position: int) -> tuple[TradeOrder]
|
||||
def get_orders_by_position(self, *, position: int) -> tuple[TradeOrder, ...]
|
||||
```
|
||||
Get orders by position.
|
||||
#### Parameters
|
||||
| Name | Type | Description | Default |
|
||||
|------------|------|-----------------------|---------|
|
||||
| `position` | `int`| Position number to get | 0 |
|
||||
| Name | Type | Description |
|
||||
|------------|-------|------------------------|
|
||||
| `position` | `int` | Position number to get |
|
||||
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|----------|---------------------|------------------------|---------|
|
||||
| `orders` | `tuple[TradeOrder]` | A list of trade orders | [] |
|
||||
| Name | Type | Description |
|
||||
|----------|--------------------------|-------------------------|
|
||||
| `orders` | `tuple[TradeOrder, ...]` | A tuple of trade orders |
|
||||
|
||||
<a id='get_order_ticket'></a>
|
||||
### get_order_ticket
|
||||
<a id='history.get_orders_by_ticket'></a>
|
||||
### get_orders_by_ticket
|
||||
```python
|
||||
async def get_order_ticket(self, ticket: int | None = None) -> TradeOrder
|
||||
def get_orders_by_ticket(self, *, position: int) -> tuple[TradeOrder, ...]
|
||||
```
|
||||
Get a single order by ticket number.
|
||||
|
||||
Get orders by ticket number. This filters orders by ticket based on the orders already fetched in initialize.
|
||||
#### Parameters
|
||||
| Name | Type | Description | Default |
|
||||
|----------|-------|----------------------|---------|
|
||||
| `ticket` | `int` | Ticket number to get | 0 |
|
||||
| Name | Type | Description |
|
||||
|----------|-------|----------------------|
|
||||
| `ticket` | `int` | ticket number to get |
|
||||
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|----------|---------------------|------------------------|---------|
|
||||
| `order` | `TradeOrder` | A single trade order | None |
|
||||
|
||||
<a id='orders_total'></a>
|
||||
### orders_total
|
||||
```python
|
||||
async def orders_total() -> int
|
||||
```
|
||||
Get total number of orders within the specified period in the constructor.
|
||||
#### Returns
|
||||
| Name | Type | Description | Default |
|
||||
|----------------|-------|---------------------|---------|
|
||||
| `total_orders` | `int` | Total number orders | 0 |
|
||||
| Name | Type | Description |
|
||||
|----------|--------------------------|-------------------------|
|
||||
| `orders` | `tuple[TradeOrder, ...]` | A tuple of trade orders |
|
||||
|
||||
Reference in New Issue
Block a user