Skip to content

Position Info

CPositionInfo

Source code in strategytester5\trade_classes\PositionInfo.py 
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
class CPositionInfo:
    def __init__(self, position: TradePosition, terminal: Union[MetaTrader5|OverLoadedMetaTrader5API]) -> None:

        """
        A lightweight Python wrapper that resembles the MQL5 Standard Library class
        `CPositionInfo` and provides convenient, read-only access to MetaTrader 5
        open position properties.

        This class wraps a single already-selected/open position object returned by
        the MetaTrader 5 Python API, such as from `mt5.positions_get()`.

        [MQL5 Reference](https://www.mql5.com/en/docs/standardlibrary/tradeclasses/cpositioninfo)

        Parameters
        ----------
        position : Any
            A position object returned by MetaTrader 5 Python API functions such as
            `mt5.positions_get()`.
        terminal : Initialize native MetaTrader5 API or the simulated one from the StrategyTester instance

        Notes
        -----
        - This wrapper does not implement selection methods by design.
        - If no position is supplied, properties return fallback values such as
        `-1`, `0.0`, `""`, or `None`, depending on the property.
        - Time values are returned as timezone-aware UTC datetimes where applicable.

        Method groups mirror the MQL5 layout:
        - Integer properties: Time, TimeMsc, TimeUpdate, TimeUpdateMsc, PositionType, Magic, Identifier
        - Double properties: Volume, PriceOpen, StopLoss, TakeProfit, PriceCurrent, Swap, Profit
        - String properties: Symbol, Comment
        - Generic accessors: InfoInteger, InfoDouble, InfoString
        """

        self.terminal = terminal

        self._position: Optional[Any] = position

        if position is not None and not hasattr(position, "ticket"):
            raise ValueError("The provided position object does not have expected attributes.")

    # --------- Integer / datetime properties -----------

    @property
    def ticket(self) -> int:
        """Gets the ticket / identifier of the position."""
        return int(self._position.ticket) if self._position else -1

    @property
    def identifier(self) -> int:
        """Gets the ID of the position."""
        return int(self._position.identifier) if self._position else -1

    @property
    def magic(self) -> int:
        """Gets the ID of the expert that opened the position."""
        return int(self._position.magic) if self._position else -1

    @property
    def time(self) -> Optional[datetime]:
        """Gets the time of position opening."""
        return datetime.fromtimestamp(self._position.time, tz=timezone.utc) if self._position else None

    @property
    def time_msc(self) -> Optional[int]:
        """Receives the time of position opening in milliseconds since 01.01.1970."""
        return int(self._position.time_msc) if self._position else None

    @property
    def time_update(self) -> Optional[datetime]:
        """Receives the time of position changing in seconds since 01.01.1970."""
        return datetime.fromtimestamp(self._position.time_update, tz=timezone.utc) if self._position else None

    @property
    def time_update_msc(self) -> Optional[int]:
        """Receives the time of position changing in milliseconds since 01.01.1970."""
        return int(self._position.time_update_msc) if self._position else None

    @property
    def position_type(self) -> int:
        """Gets the position type."""
        return int(self._position.type) if self._position else -1

    @property
    def position_type_description(self) -> str:
        """Gets the position type as a string."""
        pos_type_map = {
            self.terminal.POSITION_TYPE_BUY: "Buy",
            self.terminal.POSITION_TYPE_SELL: "Sell"
        }
        return pos_type_map.get(self.position_type, "Unknown position type")

    # ----------- Double properties -------------

    @property
    def volume(self) -> float:
        """Gets the volume of the position."""
        return float(self._position.volume) if self._position else 0.0

    @property
    def price_open(self) -> float:
        """Gets the opening price of the position."""
        return float(self._position.price_open) if self._position else 0.0

    @property
    def stop_loss(self) -> float:
        """Gets the Stop Loss price of the position."""
        return float(self._position.sl) if self._position else 0.0

    @property
    def take_profit(self) -> float:
        """Gets the Take Profit price of the position."""
        return float(self._position.tp) if self._position else 0.0

    @property
    def price_current(self) -> float:
        """Gets the current price by position symbol."""
        return float(self._position.price_current) if self._position else 0.0

    @property
    def swap(self) -> float:
        """Gets the swap amount of the position."""
        return float(self._position.swap) if self._position else 0.0

    @property
    def profit(self) -> float:
        """Gets the current profit of the position."""
        return float(self._position.profit) if self._position else 0.0

    # Optional: some MT5 Python position objects may not expose commission
    @property
    def commission(self) -> float:
        """Gets the commission amount of the position, if available."""
        if not self._position:
            return 0.0
        value = getattr(self._position, "commission", 0.0)
        return float(value) if value is not None else 0.0

    # ------------ String properties ------------

    @property
    def symbol(self) -> str:
        """Gets the position symbol."""
        return str(self._position.symbol) if self._position else ""

    @property
    def comment(self) -> str:
        """Gets the comment of the position."""
        return str(self._position.comment) if self._position else ""

    # ------------ Generic Info* methods ------------

    def info_integer(self, prop_name: str) -> Optional[int]:
        """
        Gets the value of a specified integer type property.

        Parameters
        ----------
        prop_name : str
            Name of the position attribute.

        Returns
        -------
        Optional[int]
            Integer value if present, otherwise None.
        """
        if self._position is None or not hasattr(self._position, prop_name):
            return None
        value = getattr(self._position, prop_name)
        return None if value is None else int(value)

    def info_double(self, prop_name: str) -> Optional[float]:
        """
        Gets the value of a specified double type property.

        Parameters
        ----------
        prop_name : str
            Name of the position attribute.

        Returns
        -------
        Optional[float]
            Float value if present, otherwise None.
        """
        if self._position is None or not hasattr(self._position, prop_name):
            return None
        value = getattr(self._position, prop_name)
        return None if value is None else float(value)

    def info_string(self, prop_name: str) -> Optional[str]:
        """
        Gets the value of a specified string type property.

        Parameters
        ----------
        prop_name : str
            Name of the position attribute.

        Returns
        -------
        Optional[str]
            String value if present, otherwise None.
        """
        if self._position is None or not hasattr(self._position, prop_name):
            return None
        value = getattr(self._position, prop_name)
        return None if value is None else str(value)

    # ---------- Debug / utility helpers --------------

    def to_dict(self) -> dict[str, Any]:
        """Return all @property values as a dictionary."""
        data: dict[str, Any] = {}
        seen: set[str] = set()

        for cls in type(self).mro():
            for name, attr in vars(cls).items():
                if name in seen:
                    continue
                if isinstance(attr, property):
                    seen.add(name)
                    try:
                        data[name] = getattr(self, name)
                    except Exception as e:
                        data[name] = f"<error: {e}>"

        return data

    def print_all(self) -> None:
        """Print all @property values of the class."""
        for name, value in self.to_dict().items():
            print(f"{name:24} : {value}")

    def __repr__(self) -> str:
        props = self.to_dict()
        props_str = ", ".join(f"{k}={v!r}" for k, v in props.items())
        return f"{self.__class__.__name__}({props_str})"

comment property

Gets the comment of the position.

commission property

Gets the commission amount of the position, if available.

identifier property

Gets the ID of the position.

magic property

Gets the ID of the expert that opened the position.

position_type property

Gets the position type.

position_type_description property

Gets the position type as a string.

price_current property

Gets the current price by position symbol.

price_open property

Gets the opening price of the position.

profit property

Gets the current profit of the position.

stop_loss property

Gets the Stop Loss price of the position.

swap property

Gets the swap amount of the position.

symbol property

Gets the position symbol.

take_profit property

Gets the Take Profit price of the position.

ticket property

Gets the ticket / identifier of the position.

time property

Gets the time of position opening.

time_msc property

Receives the time of position opening in milliseconds since 01.01.1970.

time_update property

Receives the time of position changing in seconds since 01.01.1970.

time_update_msc property

Receives the time of position changing in milliseconds since 01.01.1970.

volume property

Gets the volume of the position.

__init__(position, terminal)

A lightweight Python wrapper that resembles the MQL5 Standard Library class CPositionInfo and provides convenient, read-only access to MetaTrader 5 open position properties.

This class wraps a single already-selected/open position object returned by the MetaTrader 5 Python API, such as from mt5.positions_get().

MQL5 Reference

Parameters

position : Any A position object returned by MetaTrader 5 Python API functions such as mt5.positions_get(). terminal : Initialize native MetaTrader5 API or the simulated one from the StrategyTester instance

Notes
  • This wrapper does not implement selection methods by design.
  • If no position is supplied, properties return fallback values such as -1, 0.0, "", or None, depending on the property.
  • Time values are returned as timezone-aware UTC datetimes where applicable.

Method groups mirror the MQL5 layout: - Integer properties: Time, TimeMsc, TimeUpdate, TimeUpdateMsc, PositionType, Magic, Identifier - Double properties: Volume, PriceOpen, StopLoss, TakeProfit, PriceCurrent, Swap, Profit - String properties: Symbol, Comment - Generic accessors: InfoInteger, InfoDouble, InfoString

Source code in strategytester5\trade_classes\PositionInfo.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def __init__(self, position: TradePosition, terminal: Union[MetaTrader5|OverLoadedMetaTrader5API]) -> None:

    """
    A lightweight Python wrapper that resembles the MQL5 Standard Library class
    `CPositionInfo` and provides convenient, read-only access to MetaTrader 5
    open position properties.

    This class wraps a single already-selected/open position object returned by
    the MetaTrader 5 Python API, such as from `mt5.positions_get()`.

    [MQL5 Reference](https://www.mql5.com/en/docs/standardlibrary/tradeclasses/cpositioninfo)

    Parameters
    ----------
    position : Any
        A position object returned by MetaTrader 5 Python API functions such as
        `mt5.positions_get()`.
    terminal : Initialize native MetaTrader5 API or the simulated one from the StrategyTester instance

    Notes
    -----
    - This wrapper does not implement selection methods by design.
    - If no position is supplied, properties return fallback values such as
    `-1`, `0.0`, `""`, or `None`, depending on the property.
    - Time values are returned as timezone-aware UTC datetimes where applicable.

    Method groups mirror the MQL5 layout:
    - Integer properties: Time, TimeMsc, TimeUpdate, TimeUpdateMsc, PositionType, Magic, Identifier
    - Double properties: Volume, PriceOpen, StopLoss, TakeProfit, PriceCurrent, Swap, Profit
    - String properties: Symbol, Comment
    - Generic accessors: InfoInteger, InfoDouble, InfoString
    """

    self.terminal = terminal

    self._position: Optional[Any] = position

    if position is not None and not hasattr(position, "ticket"):
        raise ValueError("The provided position object does not have expected attributes.")

info_double(prop_name)

Gets the value of a specified double type property.

Parameters

prop_name : str Name of the position attribute.

Returns

Optional[float] Float value if present, otherwise None.

Source code in strategytester5\trade_classes\PositionInfo.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
def info_double(self, prop_name: str) -> Optional[float]:
    """
    Gets the value of a specified double type property.

    Parameters
    ----------
    prop_name : str
        Name of the position attribute.

    Returns
    -------
    Optional[float]
        Float value if present, otherwise None.
    """
    if self._position is None or not hasattr(self._position, prop_name):
        return None
    value = getattr(self._position, prop_name)
    return None if value is None else float(value)

info_integer(prop_name)

Gets the value of a specified integer type property.

Parameters

prop_name : str Name of the position attribute.

Returns

Optional[int] Integer value if present, otherwise None.

Source code in strategytester5\trade_classes\PositionInfo.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
def info_integer(self, prop_name: str) -> Optional[int]:
    """
    Gets the value of a specified integer type property.

    Parameters
    ----------
    prop_name : str
        Name of the position attribute.

    Returns
    -------
    Optional[int]
        Integer value if present, otherwise None.
    """
    if self._position is None or not hasattr(self._position, prop_name):
        return None
    value = getattr(self._position, prop_name)
    return None if value is None else int(value)

info_string(prop_name)

Gets the value of a specified string type property.

Parameters

prop_name : str Name of the position attribute.

Returns

Optional[str] String value if present, otherwise None.

Source code in strategytester5\trade_classes\PositionInfo.py 
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def info_string(self, prop_name: str) -> Optional[str]:
    """
    Gets the value of a specified string type property.

    Parameters
    ----------
    prop_name : str
        Name of the position attribute.

    Returns
    -------
    Optional[str]
        String value if present, otherwise None.
    """
    if self._position is None or not hasattr(self._position, prop_name):
        return None
    value = getattr(self._position, prop_name)
    return None if value is None else str(value)

print_all()

Print all @property values of the class.

Source code in strategytester5\trade_classes\PositionInfo.py 
239
240
241
242
def print_all(self) -> None:
    """Print all @property values of the class."""
    for name, value in self.to_dict().items():
        print(f"{name:24} : {value}")

to_dict()

Return all @property values as a dictionary.

Source code in strategytester5\trade_classes\PositionInfo.py 
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
def to_dict(self) -> dict[str, Any]:
    """Return all @property values as a dictionary."""
    data: dict[str, Any] = {}
    seen: set[str] = set()

    for cls in type(self).mro():
        for name, attr in vars(cls).items():
            if name in seen:
                continue
            if isinstance(attr, property):
                seen.add(name)
                try:
                    data[name] = getattr(self, name)
                except Exception as e:
                    data[name] = f"<error: {e}>"

    return data