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

v4.1.0

Browse Source
This commit is contained in:
Ichinga Samuel
2026-02-27 04:11:38 +01:00
parent cb2c700752
commit eed7e80c0d
15 changed files with 430 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lib/order.md
+31 -9
View File
@@ -7,7 +7,7 @@
The `Order` class creates and manages trade orders for the MetaTrader 5 terminal. It handles
margin calculations, profit projections, order validation, modification, and cancellation.
Inherits from [`_Base`](../core/base.md).
Inherits from [`_Base`](../core/base.md) and `TradeRequest`.
## Classes
@@ -30,32 +30,54 @@ Inherits from [`_Base`](../core/base.md).
| `type_filling` | `OrderFilling` | Filling policy |
| `type_time` | `OrderTime` | Time-in-force policy |
#### Initialisation
| Method | Description |
|--------|-------------|
| `__init__(**kwargs)` | Requires `symbol`. Defaults: `action=TradeAction.DEAL`, `type_time=OrderTime.DAY`, `type_filling=OrderFilling.FOK` |
#### `request` *(property)*
Returns the trade request as a dict, filtering out `None` values.
Returns the trade request as a dict, filtering to keys valid for `TradeRequest`.
#### Validation
| Method | Returns | Description |
|--------|---------|-------------|
| `check()` | `OrderCheckResult` | Validates the order, raises `OrderError` on failure |
| `check(**kwargs)` | `OrderCheckResult` | Validates the order; raises `OrderError` on failure |
#### Execution
| Method | Returns | Description |
|--------|---------|-------------|
| `send()` | `OrderSendResult` | Sends the order; retries on requote/timeout |
| `send()` | `OrderSendResult` | Sends the order via `send_order()` |
| `send_order(request, connection_retries=0)` | `OrderSendResult` | Class method. Sends a trade request; retries up to 3 times on connection loss (retcode 10031). Raises `OrderError` on failure |
#### Calculations
| Method | Returns | Description |
|--------|---------|-------------|
| `calc_margin()` | `float \| None` | Required margin for the order |
| `calc_profit(close_price)` | `float \| None` | Projected profit at a given close price |
| `calc_profit()` | `float \| None` | Projected profit at `tp` (take profit) price |
| `calc_loss()` | `float \| None` | Projected loss at `sl` (stop loss) price |
| `profit_to_price(profit, order_type, volume, symbol, price_open)` | `float` | Class method. Reverse-calculates the close price needed to achieve a target profit |
#### Modification
| Method | Description |
|--------|-------------|
| `modify(**kwargs)` | Modifies a pending order's parameters |
| `cancel()` | Cancels a pending order |
| Method | Returns | Description |
|--------|---------|-------------|
| `modify(**kwargs)` | — | Updates the order's attributes |
| `cancel_order(order, symbol="")` | `OrderSendResult` | Class method. Cancels a pending order by ticket; raises `OrderError` on failure |
#### Pending & Historical Orders
| Method | Returns | Description |
|--------|---------|-------------|
| `orders_total()` | `int` | Class method. Total number of active pending orders |
| `get_pending_order(ticket)` | `TradeOrder \| None` | Class method. Gets a single pending order by ticket |
| `get_pending_orders(ticket, symbol, group)` | `tuple[TradeOrder, ...]` | Class method. Gets pending orders filtered by ticket, symbol, or group |
| `get_history_order_by_ticket(ticket)` | `TradeOrder \| None` | Class method. Gets a historical order by ticket |
## Synchronous API
Available in `aiomql.lib.sync.order`. All async methods become synchronous with the same signatures.