gavindiaz/aiomql
1
0
Fork 0
mirror of https://github.com/Ichinga-Samuel/aiomql.git synced 2026-08-15 21:08:06 +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/strategy.md
+27 -52
View File
@@ -1,77 +1,52 @@
<a id="aiomql.strategy"></a>
# aiomql.strategy
## <a id="strategy"></a> Strategy
The base class for creating strategies.
<a id="aiomql.strategy.Strategy"></a>
## Strategy Objects
```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|
**Attributes**:
- `symbol` _Symbol_ - The Financial Instrument as a Symbol Object
- `parameters` _Dict_ - A dictionary of parameters for the strategy.
Class Attributes:
- `name` _str_ - A name for the strategy.
- `account` _Account_ - Account instance.
- `mt5` _MetaTrader_ - MetaTrader instance.
- `config` _Config_ - Config instance.
**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="aiomql.strategy.Strategy.__init__"></a>
#### \_\_init\_\_
### Notes:
Define the name of a strategy as a class attribute. If not provided, the class name will be used as the name.
### \_\_init\_\_
```python
def __init__(*, symbol: Symbol, params: dict = None)
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.
### Arguments:
|Name| Type | Description | Default |
|---|--------------------|-----------------------------|-------------------|
|**symbol**| **Symbol** | The Financial instrument | None |
|**params**| **Dict** | Trading strategy parameters | None |
|**sessions**| **Sessions** | Trading sessions | None |
Initiate the parameters dict and add name and symbol fields.
Use class name as strategy name if name is not provided
**Arguments**:
- `symbol` _Symbol_ - The Financial instrument
- `params` _Dict_ - Trading strategy parameters
<a id="aiomql.strategy.Strategy.sleep"></a>
#### sleep
### 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.
**Arguments**:
- `secs` _float_ - The time in seconds. Usually the timeframe you are trading on.
<a id="aiomql.strategy.Strategy.trade"></a>
#### trade
### Arguments:
|Name| Type | Description | Default |
|---|--------------------|-----------------------------|-------------------|
|**secs**| **float** | The time in seconds. Usually the timeframe you are trading on. | None |
### 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.