gavindiaz/aiomql
1
0
Fork 0
mirror of https://github.com/Ichinga-Samuel/aiomql.git synced 2026-08-20 23:38:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

v4

Browse Source
This commit is contained in:
Ichinga Samuel
2024-11-10 12:25:50 +01:00
parent d9bd84bc2e
commit f56d0c85b3
39 changed files with 1538 additions and 1179 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lib/trader.md
+133 -64
View File
@@ -3,111 +3,180 @@ Trader class module. Handles the creation of an order and the placing of trades
## Table of Contents
- [Trader](#trader)
- [\_\_init\_\_](#__init__)
- [create\_order](#create_order)
- [set\_order\_limits](#set_order_limits)
- [set\_trade\_stop_levels](#set_trade_stop_levels)
- [send\_order](#send_order)
- [check_order](#check_order)
- [record_trade](#record_trade)
- [place\_trade](#place_trade)
- [\_\_init\_\_](#trader.__init__)
- [set_trade_stop_levels_points](#trader.set_trade_stop_levels_points)
- [set_trade_stop_levels_pips](#trader.set_trade_stop_levels_pips)
- [create_order_with_points](#trade.create_order_with_points)
- [create_order_with_sl](#trade.create_order_with_sl)
- [create_order_with_stops](#trade.create_order_with_stops)
- [create_order_no_stops](#trade.create_order_no_stops)
- [send_order](#trader.send_order)
- [check_order](#trader.check_order)
- [record_trade](#trader.record_trade)
- [place_trade](#trader.place_trade)
<a name="trader"></a>
<a name="trader.trader"></a>
### Trader
```python
class Trader()
```
Base class for creating a Trader object. Handles the creation of an order and the placing of trades
#### Attributes
| Name | Type | Description | Default |
|----------|----------|-------------------------------------------------------|---------|
| `ram` | `RAM` | Risk Assessment Management System. | None |
| `config` | `Config` | Config instance. | None |
| `order` | `Order` | Order instance. | None |
| `symbol` | `Symbol` | The Financial Instrument | None |
| `params` | `Dict` | A dictionary of parameters associated with the trade. | None |
<a name="init"></a>
#### Attributes:
| Name | Type | Description | Default |
|--------------|----------|-------------------------------------------------------|---------|
| `ram` | `RAM` | Risk Assessment Management System. | None |
| `config` | `Config` | Config instance. | None |
| `order` | `Order` | Order instance. | None |
| `symbol` | `Symbol` | The Financial Instrument | None |
| `parameters` | `dict` | A dictionary of parameters associated with the trade. | None |
<a name="trader.__init__"></a>
### \_\_init\_\_
```python
def __init__(*, symbol: Symbol, ram: RAM = None)
```
#### Parameters
#### Parameters:
| Name | Type | Description | Default |
|----------|----------|-----------------------------------------|---------|
| `symbol` | `Symbol` | The Financial instrument | None |
| `symbol` | `Symbol` | The Financial instrument | |
| `ram` | `RAM` | Risk Assessment and Management instance | None |
<a name="create_order"></a>
### create\_order
```python
async def create_order(*, order_type: OrderType, `kwargs)
```
Complete the order object with the required values. Creates a simple order.
#### Parameters
| Name | Type | Description | Default |
|--------------|-------------|-------------------------------------------------------|---------|
| `order_type` | `OrderType` | Type of order | None |
| `kwargs` | | keyword arguments as required for the specific trader | |
<a name="set_order_limits"></a>
### set\_order\_limits
<a name="trader.set_trade_stop_levels_pips"></a>
### set_trade_stop_levels_pips
```python
async def set_order_limits(pips: float):
async def set_trade_stop_levels_pips(*, pips: float, risk_to_reward: float = None):
```
Sets the stop loss and take profit for the order. This method uses pips as defined for forex instruments.
#### Parameters
| Name | Type | Description | Default |
|--------|---------|-------------|---------|
| `pips` | `float` | Target pips | None |
<a name="set_trade_stop_levels"></a>
### set\_trade\_stop\_levels
#### Parameters:
| Name | Type | Description | Default |
|------------------|---------|-------------------------------|---------|
| `pips` | `float` | Target pips | |
| `risk_to_reward` | `float` | Optional risk to reward ratio | None |
<a name="trader.set_trade_stop_levels_points"></a>
### set_trade_stop_levels_points
```python
async def set_trade_stop_levels(*, points)
async def set_trade_stop_levels_points(*, points: float, risk_to_reward: float = None):
```
sets the stop loss and take profit for the order. This method uses points as defined by MetaTrader5 for all symbols.
#### Parameters
| Name | Type | Description | Default |
|----------|---------|---------------|---------|
| `points` | `float` | Target points | None |
Sets the stop loss and take profit for the order. This method uses points as defined for forex instruments.
<a name="send_order"></a>
### send\_order
#### Parameters:
| Name | Type | Description | Default |
|------------------|---------|-------------------------------|---------|
| `points` | `float` | Target points | |
| `risk_to_reward` | `float` | Optional risk to reward ratio | None |
<a name="trader.create_order_no_stops"></a>
### create_order_no_stops
```python
async def send_order()
async def create_order_no_stops(*, order_type: OrderType, volume: float = None)
```
Sends the order to the broker for execution. Record the trade.
Create an order without setting stop loss and take profit. Using minimum lot size.
<a name="check_order"></a>
#### Parameters:
| Name | Type | Description | Default |
|--------------|-------------|---------------------|---------|
| `order_type` | `OrderType` | The order type | |
| `volume` | `float` | The volume to trade | None |
<a name="trader.create_order_with_stops"></a>
### create_order_with_stops
```python
async def create_order_with_stops(*, order_type: OrderType, sl: float, tp: float, amount_to_risk: float = None)
```
Create an order with stop loss and take profit levels. Use the amount to risk per trade to
calculate the volume.
#### Parameters:
| Name | Type | Description | Default |
|------------------|-------------|--------------------|---------|
| `order_type` | `OrderType` | The order type | |
| `sl` | `float` | The stop loss` | |
| `tp` | `float` | The take profit` | |
| `amount_to_risk` | `float` | The amount to risk | None |
<a name="trader.create_order_with_sl"></a>
### create_order_with_sl
```python
async def create_order_with_sl(*, order_type: OrderType, sl: float, amount_to_risk: float = None, risk_to_reward: float = None)
```
Create an order with a given stop_loss level. Use the amount to risk per trade to calculate the volume.
#### Parameters:
| Name | Type | Description | Default |
|------------------|-------------|------------------------------------------|---------|
| `order_type` | `OrderType` | The order type | |
| `sl` | `float` | The stop loss` | |
| `risk_to_reward` | `float` | Risk to reward ratio. Optional parameter | None |
| `amount_to_risk` | `float` | The amount to risk | None |
<a name="trader.create_order_with_points"></a>
### create_order_with_points
```python
async def create_order_with_points(*, order_type: OrderType, points: float, amount_to_risk: float = None, risk_to_reward: float = None)
```
Create an order with specific points to risk. Use the amount to risk per trade to calculate the volume.
#### Parameters:
| Name | Type | Description | Default |
|------------------|-------------|------------------------------------------|---------|
| `order_type` | `OrderType` | The order type | |
| `points` | `float` | Points to risk | |
| `risk_to_reward` | `float` | Risk to reward ratio. Optional parameter | None |
| `amount_to_risk` | `float` | The amount to risk | None |
<a name="trader.send_order"></a>
### send_order
```python
async def send_order() -> OrderSendResult
```
Sends the order to the broker for execution.
#### Returns:
| Type | Description |
|-------------------|----------------------------|
| `OrderSendResult` | The OrderSendResult object |
<a name="trader.check_order"></a>
### check_order
```python
async def check_order()
async def check_order() -> OrderCheckResult
```
Checks the status of the order before placing the trade.
#### Returns
| Type | Description |
|--------|-----------------------------------|
| `bool` | True if order is valid else False |
<a name="record_trade"></a>
#### Returns:
| Type | Description |
|--------------------|-----------------------------|
| `OrderCheckResult` | The OrderCheckResult object |
<a name="trader.record_trade"></a>
### record_trade
```python
async def record_trade(result: OrderSendResult, parameters: dict = None, name: str = '', exclude: set = None)
async def record_trade(*, result: OrderSendResult, parameters: dict = None, name: str = '')
```
Records the trade and the order details if `Config.record_trades` is true. Trades are recorded as either json or csv.
#### Parameters
#### Parameters:
| Name | Type | Description | Default |
|--------------|-------------------|--------------------------------------------------------------|---------|
| `result` | `OrderSendResult` | The result of the placed order | None |
| `result` | `OrderSendResult` | The result of the placed order | |
| `parameters` | `dict` | parameters to saved instead of the ones in `self.parameters` | None |
| `name` | `str` | Name for the csv or json file | '' |
| `exclude` | `set` | Set of keys to exclude from the saved parameters | None |
<a name="place_trade"></a>
### place\_trade
<a name="trader.place_trade"></a>
### place_trade
```python
@abstractmethod
async def place_trade(self, *args, **kwargs):
async def place_trade(self, *args, **kwargs)
```
Places a trade. All traders must implement this method.