aiomql/docs/lib/order.md

Order

Table of contents

• Order
• __init__
• orders_total
• get_order
• get_orders
• check
• send
• calc_margin
• calc_profit

Order

class Order(TradeRequest)

Trade order related functions and attributes. Subclass of TradeRequest.

__init__

def __init__(**kwargs)

Initialize the order object with keyword arguments, symbol must be provided. Provides default values for action, type_time and type_filling if not provided.

Arguments

Name	Type	Description	Default
action	TradeAction	Trade action	TradeAction.DEAL
type_time	OrderTime	Order time	OrderTime.DAY
type_filling	OrderFilling	Order filling	OrderFilling.FOK

orders_total

async def orders_total()

Get the total number of active orders.

Returns

Type	Description
int	total number of active orders

get_order

async def get_order(self, ticket: int) -> TradeOrder

Get an active trade order by ticket.

get_orders

async def get_orders(self, *, ticket: int = 0, symbol: str = '', group: str = '', retries=3) -> tuple[TradeOrder]:

Get active trade orders. If ticket is provided, it will return the order with the specified ticket. If symbol is provided, it will return all orders for the specified symbol. If group is provided, it will return all orders for the specified group.

Parameters

Name	Type	Description	Default
ticket	int	Order ticket	0
symbol	str	Symbol name	''
group	str	Group name	''

Returns

Type	Description
tuple[TradeOrder]	A Tuple of active trade orders as TradeOrder objects

Raises

Exception	Description
OrderError	If not successful

check

async def check() -> OrderCheckResult

Check funds sufficiency for performing a required trading operation and the possibility of executing it at the current market price.

Returns

Type	Description
OrderCheckResult	An OrderCheckResult object

Raises:

Exception	Description
OrderError	If not successful

send

async def send() -> OrderSendResult

Send a request to perform a trading operation from the terminal to the trade server.

Returns

Type	Description
OrderSendResult	An OrderSendResult object

Raises:

Exception	Description
OrderError	If not successful

calc_margin

async def calc_margin() -> float

Return the required margin in the account currency to perform a specified trading operation.

Returns

Type	Description
float	Returns float value if successful

Raises

Exception	Description
OrderError	If not successful

calc_profit

async def calc_profit() -> float

Return profit in the account currency for a specified trading operation.

Returns

Type	Description
float	Returns float value if successful
None	If not successful