mirror of
https://github.com/Ichinga-Samuel/aiomql.git
synced 2026-08-04 15:57:44 +00:00
Ichinga Samuel
66 lines
2.6 KiB
Markdown
66 lines
2.6 KiB
Markdown
# Strategy
|
|
The base class for creating strategies.
|
|
|
|
## Table of Contents
|
|
- [Strategy](#strategy)
|
|
- [\_\_init\_\_](#init)
|
|
- [sleep](#sleep)
|
|
- [trade](#trade)
|
|
|
|
|
|
<a id="strategy"></a>
|
|
### Strategy
|
|
```python
|
|
class Strategy(ABC)
|
|
```
|
|
The base class for creating strategies.
|
|
#### Attributes
|
|
| Name | Type | Description | Default |
|
|
|--------------|--------------|----------------------------------------------|---------|
|
|
| `name` | `str` | A name for the strategy. | None |
|
|
| `account` | `Account` | Account instance. | None |
|
|
| `mt5` | `MetaTrader` | MetaTrader instance. | None |
|
|
| `config` | `Config` | Config instance. | None |
|
|
| `symbol` | `Symbol` | The Financial Instrument as a Symbol Object | None |
|
|
| `parameters` | `Dict` | A dictionary of parameters for the strategy. | None |
|
|
| `sessions` | `Sessions` | Trading sessions. | None |
|
|
|
|
### Notes
|
|
Define the name of a strategy as a class attribute. If not provided, the class name will be used as the name.
|
|
|
|
<a id="init"></a>
|
|
### \_\_init\_\_
|
|
```python
|
|
def __init__(*, symbol: Symbol, params: dict = None, sessions: Sessions)
|
|
```
|
|
Initiate the parameters dict and add name and symbol fields. Use class name as strategy name if name is not provided.
|
|
#### Parameters
|
|
| Name | Type | Description | Default |
|
|
|------------|------------|-----------------------------|---------|
|
|
| `symbol` | `Symbol` | The Financial instrument | None |
|
|
| `params` | `Dict` | Trading strategy parameters | None |
|
|
| `sessions` | `Sessions` | Trading sessions | None |
|
|
|
|
<a id="sleep"></a>
|
|
### sleep
|
|
```python
|
|
@staticmethod
|
|
async def sleep(secs: float)
|
|
```
|
|
Sleep for the needed amount of seconds in between requests to the terminal.
|
|
computes the accurate amount of time needed to sleep ensuring that the next request is made at the start of
|
|
a new bar and making cooperative multitasking possible.
|
|
#### Parameters
|
|
| Name | Type | Description | Default |
|
|
|--------|---------|----------------------------------------------------------------|---------|
|
|
| `secs` | `float` | The time in seconds. Usually the timeframe you are trading on. | None |
|
|
|
|
<a id="trade"></a>
|
|
### trade
|
|
```python
|
|
@abstractmethod
|
|
async def trade()
|
|
```
|
|
Place trades using this method. This is the main method of the strategy.
|
|
It will be called by the strategy runner.
|