ctrader-api-client 0.2.2__tar.gz → 0.3.0__tar.gz

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/.pre-commit-config.yaml

@@ -1,4 +1,12 @@
 repos:
+  - repo: local
+    hooks:
+      - id: local-ci
+        name: Local CI Checks
+        entry: just ci
+        language: system
+        pass_filenames: false
+
   # Ruff for linting & formatting
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.9

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/Justfile

@@ -10,11 +10,16 @@ default: help
 help:
     just --list
 
+# Spin up documentation server using MkDocs
+documentation:
+    uv run mkdocs serve
+
 # Run all CI steps: linting, formatting, type checking
 ci directory='':
     @just lint {{directory}}
     @just fmt {{directory}}
     @just type-check {{directory}}
+    @just test {{directory}}
 
 # Lint the codebase using ruff, optionally specifying a directory to lint.
 lint directory='':

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ctrader-api-client
-Version: 0.2.2
+Version: 0.3.0
 Summary: API Client to interact with the cTrader Open API spec
 Author-email: Elio <elioachukri@pm.me>
 License-File: LICENSE

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/docs/api/accounts.md

@@ -41,4 +41,3 @@ for acc in accounts:
 ## Related
 
 - [Authentication](client.md#authentication) - Authenticating accounts
-- [Models - Account](models.md#account) - Account model reference

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/docs/api/events.md

@@ -108,10 +108,6 @@ async def on_ready(event: ReadyEvent):
     options:
       show_source: false
 
-::: ctrader_api_client.events.PnLChangeEvent
-    options:
-      show_source: false
-
 ::: ctrader_api_client.events.TrailingStopChangedEvent
     options:
       show_source: false

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/docs/api/models.md

@@ -102,6 +102,9 @@ partial_close = ClosePositionRequest(
     options:
       show_source: false
 
+::: ctrader_api_client.models.PositionUnrealizedPnL
+    options:
+      show_source: false
 
 ::: ctrader_api_client.models.Order
     options:

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/docs/api/trading.md

@@ -10,6 +10,7 @@ Access via `client.trading`.
     options:
       show_source: false
       members:
+        - get_unrealized_pnl_per_position
         - place_order
         - amend_order
         - cancel_order
@@ -175,3 +176,12 @@ for deal in deals:
     if deal.is_closing_deal and deal.close_detail:
         print(f"  Gross P/L: {deal.close_detail.gross_profit}")
 ```
+
+### Get PnL for all open positions
+
+```python
+unrealized_pnl = await client.trading.get_unrealized_pnl_per_position(account_id)
+
+for p in unrealized_pnl:
+    print(f"Position {p.position_id}: Gross Unrealized PnL = {p.gross_unrealized_pnl}, Net Unrealized PnL = {p.net_unrealized_pnl}")
+```

ctrader_api_client-0.3.0/protos/VERSION

@@ -0,0 +1 @@
+main

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/protos/vendor/OpenApiMessages.proto

@@ -91,8 +91,8 @@ message ProtoOANewOrderReq {
     optional double stopPrice = 8; // Stop Price, can be specified for the STOP and the STOP_LIMIT orders only.
     optional ProtoOATimeInForce timeInForce = 9 [default = GOOD_TILL_CANCEL]; // The specific order execution or expiration instruction - GOOD_TILL_DATE, GOOD_TILL_CANCEL, IMMEDIATE_OR_CANCEL, FILL_OR_KILL, MARKET_ON_OPEN.
     optional int64 expirationTimestamp = 10; // The Unix time in milliseconds of Order expiration. Should be set for the Good Till Date orders.
-    optional double stopLoss = 11; // The absolute Stop Loss price (1.23456 for example). Not supported for the MARKER orders.
-    optional double takeProfit = 12; // The absolute Take Profit price (1.23456 for example). Unsupported for the MARKER orders.
+    optional double stopLoss = 11; // The absolute Stop Loss price (1.23456 for example). Not supported for MARKET orders.
+    optional double takeProfit = 12; // The absolute Take Profit price (1.23456 for example). Unsupported for MARKET orders.
     optional string comment = 13; // User-specified comment. MaxLength = 512.
     optional double baseSlippagePrice = 14; // Base price to calculate relative slippage price for MARKET_RANGE order.
     optional int32 slippageInPoints = 15; // Slippage distance for MARKET_RANGE and STOP_LIMIT order.
@@ -139,8 +139,8 @@ message ProtoOAAmendOrderReq {
     optional double limitPrice = 5; // The Limit Price, can be specified for the LIMIT order only.
     optional double stopPrice = 6; // The Stop Price, can be specified for the STOP and the STOP_LIMIT orders.
     optional int64 expirationTimestamp = 7; // The Unix timestamp in milliseconds of Order expiration. Should be set for the Good Till Date orders.
-    optional double stopLoss = 8; // The absolute Stop Loss price (e.g. 1.23456). Not supported for the MARKER orders.
-    optional double takeProfit = 9; // The absolute Take Profit price (e.g. 1.23456). Not supported for the MARKER orders.
+    optional double stopLoss = 8; // The absolute Stop Loss price (e.g. 1.23456). Not supported for MARKET orders.
+    optional double takeProfit = 9; // The absolute Take Profit price (e.g. 1.23456). Not supported for MARKET orders.
     optional int32 slippageInPoints = 10; // Slippage distance for the MARKET_RANGE and the STOP_LIMIT orders.
     optional int64 relativeStopLoss = 11; // The relative Stop Loss can be specified instead of the absolute one. Specified in 1/100000 of a unit of price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782) For BUY stopLoss = entryPrice - relativeStopLoss, for SELL stopLoss = entryPrice + relativeStopLoss.
     optional int64 relativeTakeProfit = 12; // The relative Take Profit can be specified instead of the absolute one. Specified in 1/100000 of a unit of price. (e.g. 123000 in protocol means 1.23, 53423782 means 534.23782) For BUY takeProfit = entryPrice + relativeTakeProfit, for SELL takeProfit = entryPrice - relativeTakeProfit.
@@ -637,7 +637,7 @@ message ProtoOAAccountLogoutReq {
     required int64 ctidTraderAccountId = 2; // The unique identifier of the trader's account in cTrader platform.
 }
 
-/** Response to the ProtoOATraderLogoutReq request. Actual logout of trading account will be completed on ProtoOAAccountDisconnectEvent. */
+/** Response to the ProtoOAAccountLogoutReq request. Actual logout of trading account will be completed on ProtoOAAccountDisconnectEvent. */
 message ProtoOAAccountLogoutRes {
     optional ProtoOAPayloadType payloadType = 1 [default = PROTO_OA_ACCOUNT_LOGOUT_RES];
 
@@ -793,36 +793,3 @@ message ProtoOAGetPositionUnrealizedPnLRes {
     repeated ProtoOAPositionUnrealizedPnL positionUnrealizedPnL = 3; // Information about trader's positions' unrealized PnLs.
     required uint32 moneyDigits = 4; // Specifies the exponent of various monetary values. E.g., moneyDigits = 8 should be interpreted as the value multiplied by 10^8 with the 'real' value equal to 10053099944 / 10^8 = 100.53099944. Affects positionUnrealizedPnL.grossUnrealizedPnL, positionUnrealizedPnL.netUnrealizedPnL.
 }
-
-// The event that is sent when the unrealized PnL is changed due to market movement. Requires subscribing to PnL events, see ProtoOAv1PnLChangeSubscribeReq
-message ProtoOAv1PnLChangeEvent {
-	optional ProtoOAPayloadType payloadType = 1	[default = PROTO_OA_V1_PNL_CHANGE_EVENT];
-	required int64 ctidTraderAccountId = 2; //Unique identifier of the trader's account. Used to match responses to trader's accounts.
-	required int64 grossUnrealizedPnL = 3; //The gross unrealized PnL denoted in the account deposit currency
-	required int64 netUnrealizedPnL = 4; //The net unrealized PnL denoted in the account deposit currency
-	required uint32 moneyDigits = 5; //Specifies the exponent of various monetary values. E.g., moneyDigits = 8 should be interpreted as the value multiplied by 10^8 with the 'real' value equal to 10053099944 / 10^8 = 100.53099944
-}
-
-//The request to subscribe to ProtoOAv1PnLChangeEvent
-message ProtoOAv1PnLChangeSubscribeReq {
-	optional ProtoOAPayloadType payloadType = 1	[default = PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_REQ];
-	required int64 ctidTraderAccountId = 2; //Unique identifier of the trader's account. Used to match responses to trader's accounts.
-}
-
-//The response for ProtoOAv1PnLChangeSubscribeReq
-message ProtoOAv1PnLChangeSubscribeRes {
-	optional ProtoOAPayloadType payloadType = 1	[default = PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_RES];
-	required int64 ctidTraderAccountId = 2; // The unique identifier of the trader's account in cTrader platform.
-}
-
-//The request to stop an existing subscription to PnL events. The subscriber who sends this request will stop receiving ProtoOAv1PnLChangeEvent
-message ProtoOAv1PnLChangeUnSubscribeReq {
-	optional ProtoOAPayloadType payloadType = 1	[default = PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_REQ];
-	required int64 ctidTraderAccountId = 2; //Unique identifier of the trader's account. Used to match responses to trader's accounts.
-}
-
-//The response for ProtoOAv1PnLChangeUnSubscribeReq
-message ProtoOAv1PnLChangeUnSubscribeRes {
-	optional ProtoOAPayloadType payloadType = 1	[default = PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_RES];
-	required int64 ctidTraderAccountId = 2; //Unique identifier of the trader's account. Used to match responses to trader's accounts.
-}

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/protos/vendor/OpenApiModelMessages.proto

@@ -100,11 +100,6 @@ enum ProtoOAPayloadType {
     PROTO_OA_DEAL_OFFSET_LIST_RES = 2186;
     PROTO_OA_GET_POSITION_UNREALIZED_PNL_REQ = 2187;
     PROTO_OA_GET_POSITION_UNREALIZED_PNL_RES = 2188;
-    PROTO_OA_V1_PNL_CHANGE_EVENT = 2189;
-    PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_REQ = 2190;
-    PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_RES = 2191;
-    PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_REQ = 2192;
-    PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_RES = 2193;
 }
 
 /** Asset entity. */
@@ -328,7 +323,7 @@ enum ProtoOAOrderStatus {
     ORDER_STATUS_CANCELLED = 5; // Order is cancelled. Might be valid for orders with partially filled volume that were cancelled by LP.
 }
 
-/** Stop Order and Stop Lost triggering method ENUM. */
+/** Stop Order and Stop Loss triggering method ENUM. */
 enum ProtoOAOrderTriggerMethod {
     TRADE = 1; // Stop Order: buy is triggered by ask, sell by bid; Stop Loss Order: for buy position is triggered by bid and for sell position by ask.
     OPPOSITE = 2; // Stop Order: buy is triggered by bid, sell by ask; Stop Loss Order: for buy position is triggered by ask and for sell position by bid.
@@ -687,7 +682,6 @@ enum ProtoOAErrorCode {
     UNABLE_TO_CANCEL_ORDER = 134; // Unable to cancel order.
     UNABLE_TO_AMEND_ORDER = 135; // Unable to amend order.
     SHORT_SELLING_NOT_ALLOWED = 136; // Short selling is not allowed.
-    NOT_SUBSCRIBED_TO_PNL = 137;//This session is not subscribed via ProtoOAv1PnLChangeSubscribeReq
 }
 
 enum ProtoOALimitedRiskMarginCalculationStrategy {

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ctrader-api-client"
-version = "0.2.2"
+version = "0.3.0"
 description = "API Client to interact with the cTrader Open API spec"
 readme = "README.md"
 authors = [

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/_internal/messages.py

@@ -100,11 +100,6 @@ from .proto import (
     ProtoOAUnsubscribeLiveTrendbarRes,
     ProtoOAUnsubscribeSpotsReq,
     ProtoOAUnsubscribeSpotsRes,
-    ProtoOAv1PnLChangeEvent,
-    ProtoOAv1PnLChangeSubscribeReq,
-    ProtoOAv1PnLChangeSubscribeRes,
-    ProtoOAv1PnLChangeUnSubscribeReq,
-    ProtoOAv1PnLChangeUnSubscribeRes,
     ProtoOAVersionReq,
     ProtoOAVersionRes,
     ProtoPayloadType,
@@ -207,11 +202,6 @@ _PAYLOAD_TYPE_TO_CLASS: dict[int, type[betterproto.Message]] = {
     ProtoOAPayloadType.PROTO_OA_DEAL_OFFSET_LIST_RES: ProtoOADealOffsetListRes,
     ProtoOAPayloadType.PROTO_OA_GET_POSITION_UNREALIZED_PNL_REQ: ProtoOAGetPositionUnrealizedPnLReq,
     ProtoOAPayloadType.PROTO_OA_GET_POSITION_UNREALIZED_PNL_RES: ProtoOAGetPositionUnrealizedPnLRes,
-    ProtoOAPayloadType.PROTO_OA_V1_PNL_CHANGE_EVENT: ProtoOAv1PnLChangeEvent,
-    ProtoOAPayloadType.PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_REQ: ProtoOAv1PnLChangeSubscribeReq,
-    ProtoOAPayloadType.PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_RES: ProtoOAv1PnLChangeSubscribeRes,
-    ProtoOAPayloadType.PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_REQ: ProtoOAv1PnLChangeUnSubscribeReq,
-    ProtoOAPayloadType.PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_RES: ProtoOAv1PnLChangeUnSubscribeRes,
 }
 
 

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/_internal/proto/OpenApiMessages.py

@@ -850,7 +850,7 @@ class ProtoOAAccountLogoutReq(betterproto.Message):
 @dataclass
 class ProtoOAAccountLogoutRes(betterproto.Message):
     """
-    * Response to the ProtoOATraderLogoutReq request. Actual logout of trading
+    * Response to the ProtoOAAccountLogoutReq request. Actual logout of trading
     account will be completed on ProtoOAAccountDisconnectEvent.
     """
 
@@ -1060,53 +1060,3 @@ class ProtoOAGetPositionUnrealizedPnLRes(betterproto.Message):
     ctid_trader_account_id: int = betterproto.int64_field(2)
     position_unrealized_pn_l: list["ProtoOAPositionUnrealizedPnL"] = betterproto.message_field(3)
     money_digits: int = betterproto.uint32_field(4)
-
-
-@dataclass
-class ProtoOAv1PnLChangeEvent(betterproto.Message):
-    """
-    The event that is sent when the unrealized PnL is changed due to market
-    movement. Requires subscribing to PnL events, see
-    ProtoOAv1PnLChangeSubscribeReq
-    """
-
-    payload_type: "ProtoOAPayloadType" = betterproto.enum_field(1)
-    ctid_trader_account_id: int = betterproto.int64_field(2)
-    gross_unrealized_pn_l: int = betterproto.int64_field(3)
-    net_unrealized_pn_l: int = betterproto.int64_field(4)
-    money_digits: int = betterproto.uint32_field(5)
-
-
-@dataclass
-class ProtoOAv1PnLChangeSubscribeReq(betterproto.Message):
-    """The request to subscribe to ProtoOAv1PnLChangeEvent"""
-
-    payload_type: "ProtoOAPayloadType" = betterproto.enum_field(1)
-    ctid_trader_account_id: int = betterproto.int64_field(2)
-
-
-@dataclass
-class ProtoOAv1PnLChangeSubscribeRes(betterproto.Message):
-    """The response for ProtoOAv1PnLChangeSubscribeReq"""
-
-    payload_type: "ProtoOAPayloadType" = betterproto.enum_field(1)
-    ctid_trader_account_id: int = betterproto.int64_field(2)
-
-
-@dataclass
-class ProtoOAv1PnLChangeUnSubscribeReq(betterproto.Message):
-    """
-    The request to stop an existing subscription to PnL events. The subscriber
-    who sends this request will stop receiving ProtoOAv1PnLChangeEvent
-    """
-
-    payload_type: "ProtoOAPayloadType" = betterproto.enum_field(1)
-    ctid_trader_account_id: int = betterproto.int64_field(2)
-
-
-@dataclass
-class ProtoOAv1PnLChangeUnSubscribeRes(betterproto.Message):
-    """The response for ProtoOAv1PnLChangeUnSubscribeReq"""
-
-    payload_type: "ProtoOAPayloadType" = betterproto.enum_field(1)
-    ctid_trader_account_id: int = betterproto.int64_field(2)

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/_internal/proto/OpenApiModelMessages.py

@@ -96,11 +96,6 @@ class ProtoOAPayloadType(betterproto.Enum):
     PROTO_OA_DEAL_OFFSET_LIST_RES = 2186
     PROTO_OA_GET_POSITION_UNREALIZED_PNL_REQ = 2187
     PROTO_OA_GET_POSITION_UNREALIZED_PNL_RES = 2188
-    PROTO_OA_V1_PNL_CHANGE_EVENT = 2189
-    PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_REQ = 2190
-    PROTO_OA_V1_PNL_CHANGE_SUBSCRIBE_RES = 2191
-    PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_REQ = 2192
-    PROTO_OA_V1_PNL_CHANGE_UN_SUBSCRIBE_RES = 2193
 
 
 class ProtoOADayOfWeek(betterproto.Enum):
@@ -227,7 +222,7 @@ class ProtoOAOrderStatus(betterproto.Enum):
 
 
 class ProtoOAOrderTriggerMethod(betterproto.Enum):
-    """* Stop Order and Stop Lost triggering method ENUM."""
+    """* Stop Order and Stop Loss triggering method ENUM."""
 
     TRADE = 1
     OPPOSITE = 2
@@ -406,7 +401,6 @@ class ProtoOAErrorCode(betterproto.Enum):
     UNABLE_TO_CANCEL_ORDER = 134
     UNABLE_TO_AMEND_ORDER = 135
     SHORT_SELLING_NOT_ALLOWED = 136
-    NOT_SUBSCRIBED_TO_PNL = 137
 
 
 class ProtoOALimitedRiskMarginCalculationStrategy(betterproto.Enum):

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/_internal/proto/__init__.py

@@ -97,11 +97,6 @@ from .OpenApiMessages import (
     ProtoOAUnsubscribeLiveTrendbarRes,
     ProtoOAUnsubscribeSpotsReq,
     ProtoOAUnsubscribeSpotsRes,
-    ProtoOAv1PnLChangeEvent,
-    ProtoOAv1PnLChangeSubscribeReq,
-    ProtoOAv1PnLChangeSubscribeRes,
-    ProtoOAv1PnLChangeUnSubscribeReq,
-    ProtoOAv1PnLChangeUnSubscribeRes,
     ProtoOAVersionReq,
     ProtoOAVersionRes,
 )
@@ -311,10 +306,5 @@ __all__ = [
     "ProtoOAUnsubscribeSpotsRes",
     "ProtoOAVersionReq",
     "ProtoOAVersionRes",
-    "ProtoOAv1PnLChangeEvent",
-    "ProtoOAv1PnLChangeSubscribeReq",
-    "ProtoOAv1PnLChangeSubscribeRes",
-    "ProtoOAv1PnLChangeUnSubscribeReq",
-    "ProtoOAv1PnLChangeUnSubscribeRes",
     "ProtoPayloadType",
 ]

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/api/market_data.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from collections.abc import Sequence
 from datetime import datetime
 from typing import TYPE_CHECKING
@@ -33,6 +34,9 @@ if TYPE_CHECKING:
     from ..connection import Protocol
 
 
+logger = logging.getLogger(__name__)
+
+
 # Map TrendbarPeriod enum to proto values
 _PERIOD_TO_PROTO: dict[TrendbarPeriod, int] = {
     TrendbarPeriod.M1: ProtoOATrendbarPeriod.M1,
@@ -115,6 +119,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Subscribing to spots: account=%d symbols=%s", account_id, symbol_ids)
         request = ProtoOASubscribeSpotsReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_ids,
@@ -149,6 +154,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Unsubscribing from spots: account=%d symbols=%s", account_id, symbol_ids)
         request = ProtoOAUnsubscribeSpotsReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_ids,
@@ -193,6 +199,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Subscribing to trendbars: account=%d symbol=%d period=%s", account_id, symbol_id, period.name)
         request = ProtoOASubscribeLiveTrendbarReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_id,
@@ -229,6 +236,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Unsubscribing from trendbars: account=%d symbol=%d period=%s", account_id, symbol_id, period.name)
         request = ProtoOAUnsubscribeLiveTrendbarReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_id,
@@ -270,6 +278,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Subscribing to depth: account=%d symbols=%s", account_id, symbol_ids)
         request = ProtoOASubscribeDepthQuotesReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_ids,
@@ -303,6 +312,7 @@ class MarketDataAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Unsubscribing from depth: account=%d symbols=%s", account_id, symbol_ids)
         request = ProtoOAUnsubscribeDepthQuotesReq(
             ctid_trader_account_id=account_id,
             symbol_id=symbol_ids,

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/api/trading.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import logging
 from datetime import UTC, datetime
 from decimal import Decimal
 from typing import TYPE_CHECKING
@@ -12,18 +13,18 @@ from .._internal.proto import (
     ProtoOADealListRes,
     ProtoOAExecutionEvent,
     ProtoOAExecutionType,
+    ProtoOAGetPositionUnrealizedPnLReq,
+    ProtoOAGetPositionUnrealizedPnLRes,
     ProtoOAOrderErrorEvent,
     ProtoOAOrderListReq,
     ProtoOAOrderListRes,
     ProtoOAReconcileReq,
     ProtoOAReconcileRes,
-    ProtoOAv1PnLChangeSubscribeReq,
-    ProtoOAv1PnLChangeSubscribeRes,
 )
 from ..enums import ExecutionType, OrderSide
 from ..events import ExecutionEvent
 from ..exceptions import APIError
-from ..models import Deal, Order, Position
+from ..models import Deal, Order, Position, PositionUnrealizedPnL
 from ..models.requests import (
     AmendOrderRequest,
     AmendPositionRequest,
@@ -36,6 +37,9 @@ if TYPE_CHECKING:
     from ..connection import Protocol
 
 
+logger = logging.getLogger(__name__)
+
+
 def _raise_if_order_error(response: object) -> None:
     """Raise APIError if response is an order error event.
 
@@ -164,31 +168,38 @@ class TradingAPI:
         self._protocol = protocol
         self._default_timeout = default_timeout
 
-    async def subscribe_to_pnl_changes(self, account_id: int) -> None:
-        """Subscribe to PnL change events.
-
-        After subscribing, PnL change data will be delivered via the event system.
-        Use `@client.on(PnLChangeEvent)` to handle them.
-
-        Note:
-            This subscription seems to be currently rate-limited by cTrader, so it may not work as expected.
+    async def get_unrealized_pnl_per_position(self, account_id: int) -> list[PositionUnrealizedPnL]:
+        """Get unrealized PnL for each open position.
 
         Args:
             account_id: The cTID trader account ID.
+
+        Returns:
+            List of PositionUnrealizedPnL, one per open position.
         """
-        request = ProtoOAv1PnLChangeSubscribeReq(ctid_trader_account_id=account_id)
+        request = ProtoOAGetPositionUnrealizedPnLReq(ctid_trader_account_id=account_id)
 
         response = await self._protocol.send_request(
             request,
             timeout=self._default_timeout,
         )
 
-        if not isinstance(response, ProtoOAv1PnLChangeSubscribeRes):
+        if not isinstance(response, ProtoOAGetPositionUnrealizedPnLRes):
             raise APIError(
                 error_code="UNEXPECTED_RESPONSE",
-                description=f"Expected ProtoOAv1PnLChangeSubscribeRes, got {type(response).__name__}",
+                description=f"Expected ProtoOAGetPositionUnrealizedPnLRes, got {type(response).__name__}",
             )
 
+        divisor = 10**response.money_digits
+        return [
+            PositionUnrealizedPnL(
+                position_id=p.position_id,
+                gross_unrealized_pnl=p.gross_unrealized_pn_l / divisor,
+                net_unrealized_pnl=p.net_unrealized_pn_l / divisor,
+            )
+            for p in response.position_unrealized_pn_l
+        ]
+
     async def place_order(
         self,
         account_id: int,
@@ -217,6 +228,13 @@ class TradingAPI:
             APIError: If request fails.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug(
+            "Placing order: account=%d symbol=%d type=%s volume=%d",
+            account_id,
+            request.symbol_id,
+            request.order_type.name,
+            request.volume,
+        )
         proto_request = request.to_proto(account_id)
 
         response = await self._protocol.send_request(
@@ -254,6 +272,7 @@ class TradingAPI:
             APIError: If request fails or order not found.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Amending order: account=%d order=%d", account_id, request.order_id)
         proto_request = request.to_proto(account_id)
 
         response = await self._protocol.send_request(
@@ -291,6 +310,7 @@ class TradingAPI:
             APIError: If request fails or order not found.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Cancelling order: account=%d order=%d", account_id, order_id)
         request = ProtoOACancelOrderReq(
             ctid_trader_account_id=account_id,
             order_id=order_id,
@@ -331,6 +351,7 @@ class TradingAPI:
             APIError: If request fails or position not found.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Closing position: account=%d position=%d", account_id, request.position_id)
         proto_request = request.to_proto(account_id)
 
         response = await self._protocol.send_request(
@@ -368,6 +389,7 @@ class TradingAPI:
             APIError: If request fails or position not found.
             CTraderConnectionTimeoutError: If request times out.
         """
+        logger.debug("Amending position: account=%d position=%d", account_id, request.position_id)
         proto_request = request.to_proto(account_id)
 
         response = await self._protocol.send_request(

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/client.py

@@ -19,7 +19,6 @@ from .events import (
     MarginCallTriggerEvent,
     MarginChangeEvent,
     OrderErrorEvent,
-    PnLChangeEvent,
     ReadyEvent,
     ReconnectedEvent,
     SpotEvent,
@@ -50,7 +49,6 @@ T_AccountIdOnly = TypeVar(
     SymbolChangedEvent,
     TrailingStopChangedEvent,
     MarginCallTriggerEvent,
-    PnLChangeEvent,
 )
 
 # Events that support no filters

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/config.py

@@ -13,7 +13,7 @@ class ClientConfig(BaseModel):
         client_id: OAuth application client ID.
         client_secret: OAuth application client secret.
         heartbeat_interval: Seconds between heartbeat sends.
-        heartbeat_timeout: Seconds without server heartbeat before disconnect. Set to 0 to disable.
+        heartbeat_timeout: Seconds without server-initiated messages before disconnect. Set to 0 to disable.
         request_timeout: Default timeout for API requests in seconds.
         reconnect_attempts: Max reconnection attempts (0 to disable).
         reconnect_min_wait: Initial wait between reconnection attempts.
@@ -43,7 +43,7 @@ class ClientConfig(BaseModel):
 
     # Heartbeat settings
     heartbeat_interval: float = Field(default=10.0, gt=0)
-    heartbeat_timeout: float = Field(default=0, ge=0)
+    heartbeat_timeout: float = Field(default=60.0, ge=0)
 
     # Request settings
     request_timeout: float = Field(default=30.0, gt=0)

{ctrader_api_client-0.2.2 → ctrader_api_client-0.3.0}/src/ctrader_api_client/connection/heartbeat.py

@@ -5,6 +5,7 @@ import time
 
 import anyio
 import anyio.abc
+import betterproto
 
 from .._internal.proto import ProtoHeartbeatEvent
 from .protocol import Protocol
@@ -43,10 +44,11 @@ class HeartbeatManager:
     async def start(self) -> None:
         """Start heartbeat monitoring.
 
-        Registers an event handler for incoming heartbeats and starts
-        the heartbeat send loop.
+        Registers event handlers and starts the heartbeat send loop.
         """
-        # Register handler for incoming heartbeats
+        # Track activity on any server message, not just heartbeats
+        self._protocol.on_event(betterproto.Message, self._record_activity)
+        # Keep heartbeat handler for debug logging
         self._protocol.on_event(ProtoHeartbeatEvent, self._on_heartbeat)
         self._last_received = time.monotonic()
 
@@ -54,16 +56,18 @@ class HeartbeatManager:
         self._task_group = anyio.create_task_group()
         await self._task_group.__aenter__()
         self._task_group.start_soon(self._heartbeat_loop)
+        logger.info("Heartbeat monitor started (interval=%.1fs, timeout=%.1fs)", self._interval, self._timeout)
 
     async def stop(self) -> None:
         """Stop heartbeat monitoring.
 
-        Cancels the heartbeat loop and removes the event handler.
+        Cancels the heartbeat loop and removes event handlers.
         """
         if self._task_scope is not None:
             self._task_scope.cancel()
 
         if self._task_group is not None:
+            logger.info("Heartbeat monitor stopped")
             self._task_group.cancel_scope.cancel()
             try:
                 await self._task_group.__aexit__(None, None, None)
@@ -71,6 +75,7 @@ class HeartbeatManager:
                 pass
             self._task_group = None
 
+        self._protocol.remove_handler(betterproto.Message, self._record_activity)
         self._protocol.remove_handler(ProtoHeartbeatEvent, self._on_heartbeat)
 
     async def restart(self) -> None:
@@ -82,14 +87,14 @@ class HeartbeatManager:
         self._last_received = time.monotonic()
         if self._task_group is not None:
             self._task_group.start_soon(self._heartbeat_loop)
+        logger.info("Heartbeat monitor restarted")
 
-    async def _on_heartbeat(self, _event: ProtoHeartbeatEvent) -> None:
-        """Handler called when heartbeat received from server.
-
-        Args:
-            _event: The heartbeat event from the server (unused).
-        """
+    async def _record_activity(self, _message: betterproto.Message) -> None:
+        """Reset the inactivity timer on any received server message."""
         self._last_received = time.monotonic()
+
+    async def _on_heartbeat(self, _event: ProtoHeartbeatEvent) -> None:
+        """Handler called when an explicit heartbeat is received from the server."""
         logger.debug("Heartbeat received from server")
 
     async def _heartbeat_loop(self) -> None: