aiomql/docs/order.md

Order

class Order(TradeRequest)

Trade order related functions and properties. 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
kwargs	kwargs	Keyword arguments must match the attributes of TradeRequest as well as the attributes of Order class as specified in the annotations in the class definition.	None

Default 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

Raises:

Exception	Description
SymbolError	If symbol is not provided

orders_total

async def orders_total()

Get the number of active orders.

returns:

Type	Description
int	total number of active orders

orders

async def orders() -> tuple[TradeOrder]

Get the list of active orders for the current symbol.

Returns:

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

check

async def check() -> OrderCheckResult

Check funds sufficiency for performing a required trading operation and the possibility to execute it at

returns:

Type	Description
OrderCheckResult	An OrderCheckResult object

raises:

Exception	Description
OrderError	If not successful

• 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

raises:

Exception	Description
OrderError	If not successful