mirror of
https://github.com/Ichinga-Samuel/aiomql.git
synced 2026-08-03 23:37:43 +00:00
Ichinga Samuel
114 lines
4.5 KiB
Markdown
114 lines
4.5 KiB
Markdown
# Trader
|
|
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)
|
|
|
|
<a name="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>
|
|
### \_\_init\_\_
|
|
```python
|
|
def __init__(*, symbol: Symbol, ram: RAM = None)
|
|
```
|
|
#### Parameters
|
|
| Name | Type | Description | Default |
|
|
|----------|----------|-----------------------------------------|---------|
|
|
| `symbol` | `Symbol` | The Financial instrument | None |
|
|
| `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
|
|
```python
|
|
async def set_order_limits(pips: float):
|
|
```
|
|
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
|
|
```python
|
|
async def set_trade_stop_levels(*, points)
|
|
```
|
|
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 |
|
|
|
|
<a name="send_order"></a>
|
|
### send\_order
|
|
```python
|
|
async def send_order()
|
|
```
|
|
Sends the order to the broker for execution. Record the trade.
|
|
|
|
<a name="check_order"></a>
|
|
### check_order
|
|
```python
|
|
async def check_order()
|
|
```
|
|
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>
|
|
### record_trade
|
|
```python
|
|
async def record_trade(result: OrderSendResult, parameters: dict = None, name: str = '', exclude: set = None)
|
|
```
|
|
Records the trade and the order details if `Config.record_trades` is true. Trades are recorded as either json or csv.
|
|
#### Parameters
|
|
| Name | Type | Description | Default |
|
|
|--------------|-------------------|--------------------------------------------------------------|---------|
|
|
| `result` | `OrderSendResult` | The result of the placed order | None |
|
|
| `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
|
|
```python
|
|
@abstractmethod
|
|
async def place_trade(self, *args, **kwargs):
|
|
```
|
|
Places a trade. All traders must implement this method.
|