Skip to content

Account state

Read models returned by Trader queries and trading calls.

Position dataclass

Position(ticket: int, symbol: str, side: Side, volume: float, price_open: float, sl: float | None, tp: float | None, price_current: float, profit: float, time: int, magic: int, comment: str, swap: float, identifier: int, reason: int, time_msc: int, time_update: int, time_update_msc: int, external_id: str)

An open position. sl and tp are None when not set.

ticket instance-attribute

ticket: int

symbol instance-attribute

symbol: str

side instance-attribute

side: Side

volume instance-attribute

volume: float

price_open instance-attribute

price_open: float

sl instance-attribute

sl: float | None

tp instance-attribute

tp: float | None

price_current instance-attribute

price_current: float

profit instance-attribute

profit: float

time instance-attribute

time: int

magic instance-attribute

magic: int

comment instance-attribute

comment: str

swap instance-attribute

swap: float

identifier instance-attribute

identifier: int

reason instance-attribute

reason: int

time_msc instance-attribute

time_msc: int

time_update instance-attribute

time_update: int

time_update_msc instance-attribute

time_update_msc: int

external_id instance-attribute

external_id: str

to_dict

to_dict() -> dict[str, Any]

The fields as a dict, with side as its string value.

PendingOrder dataclass

PendingOrder(ticket: int, symbol: str, side: Side, kind: PendingKind, volume: float, price: float, magic: int, comment: str)

A pending order waiting on the server.

ticket instance-attribute

ticket: int

symbol instance-attribute

symbol: str

side instance-attribute

side: Side

kind instance-attribute

volume instance-attribute

volume: float

price instance-attribute

price: float

magic instance-attribute

magic: int

comment instance-attribute

comment: str

TradeReceipt dataclass

TradeReceipt(retcode: int, deal: int, order: int, volume: float, price: float, bid: float, ask: float, comment: str, request_id: int, retcode_external: int)

Broker answer to a trade request.

Field names mirror MetaTrader5's OrderSendResult on purpose, so 2.x code reading result.retcode / result.comment keeps working unchanged.

retcode instance-attribute

retcode: int

deal instance-attribute

deal: int

order instance-attribute

order: int

volume instance-attribute

volume: float

price instance-attribute

price: float

bid instance-attribute

bid: float

ask instance-attribute

ask: float

comment instance-attribute

comment: str

request_id instance-attribute

request_id: int

retcode_external instance-attribute

retcode_external: int

Tick dataclass

Tick(bid: float, ask: float)

The current quote of a symbol.

bid instance-attribute

bid: float

ask instance-attribute

ask: float

entry_price

entry_price(side: Side) -> float

The price a market order on side fills at: ask to buy, bid to sell.

exit_price

exit_price(side: Side) -> float

The price that closes a side position: bid for a long, ask for a short.