fxsocket 0.3.0__tar.gz → 0.4.0__tar.gz

{fxsocket-0.3.0 → fxsocket-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fxsocket
-Version: 0.3.0
+Version: 0.4.0
 Summary: Python SDK for the FxSocket API — MT4/MT5 account management, trading, and real-time streaming.
 Project-URL: Homepage, https://fxsocket.com
 Project-URL: Documentation, https://api.fxsocket.com/v1/docs
@@ -42,8 +42,9 @@ interfaces.
 - **Account management** — link, list, fetch, and disconnect MT4/MT5 accounts.
 - **Private servers** — list your dedicated hosting servers and manage the
   accounts on them.
-- **Trading** — market & pending orders, modify, close, plus margin/profit calculators.
-- **Market data** — quotes, symbol specifications, OHLC history, account state & info.
+- **Trading** — market & pending orders, modify, close, close-all, plus margin/profit calculators.
+- **Market data** — quotes, symbol specifications (incl. commission rules & trading
+  sessions), OHLC history, account state & info.
 - **Live streaming** — ticks, bars, account, positions, trades, and terminal status
   over WebSocket, with automatic reconnect + subscription replay.
 - **Sync *and* async** — `Client` / `AsyncClient`, method-for-method mirrors.
@@ -157,6 +158,21 @@ if res.is_effective:        # applied now, or already in effect
     ...
 ```
 
+There's also a panic button. `close_all()` closes every open position in one
+trade-EA pass — optionally filtered by `symbol` and/or `magic` (`magic=0`
+matches manually-opened orders), and `delete_pending=True` also deletes
+matching pending orders. It returns a `CloseAllSummary` with per-ticket
+results. On a 504 the pass *continues inside the terminal* — check
+`opened_orders()` before acting again rather than re-sending:
+
+```python
+summary = term.close_all(symbol="EURUSD", delete_pending=True)
+if summary.failed:
+    for r in summary.results:
+        if not r.success:
+            print(r.ticket, r.retcode, r.retcode_description)
+```
+
 Inputs are validated client-side before they're sent. One guard worth knowing:
 in `order_modify`, a literal `stop_loss=0.0` would *remove* your stop-loss, so
 it's rejected — pass `clear_stop_loss=True` to remove one deliberately, while

{fxsocket-0.3.0 → fxsocket-0.4.0}/README.md

@@ -15,8 +15,9 @@ interfaces.
 - **Account management** — link, list, fetch, and disconnect MT4/MT5 accounts.
 - **Private servers** — list your dedicated hosting servers and manage the
   accounts on them.
-- **Trading** — market & pending orders, modify, close, plus margin/profit calculators.
-- **Market data** — quotes, symbol specifications, OHLC history, account state & info.
+- **Trading** — market & pending orders, modify, close, close-all, plus margin/profit calculators.
+- **Market data** — quotes, symbol specifications (incl. commission rules & trading
+  sessions), OHLC history, account state & info.
 - **Live streaming** — ticks, bars, account, positions, trades, and terminal status
   over WebSocket, with automatic reconnect + subscription replay.
 - **Sync *and* async** — `Client` / `AsyncClient`, method-for-method mirrors.
@@ -130,6 +131,21 @@ if res.is_effective:        # applied now, or already in effect
     ...
 ```
 
+There's also a panic button. `close_all()` closes every open position in one
+trade-EA pass — optionally filtered by `symbol` and/or `magic` (`magic=0`
+matches manually-opened orders), and `delete_pending=True` also deletes
+matching pending orders. It returns a `CloseAllSummary` with per-ticket
+results. On a 504 the pass *continues inside the terminal* — check
+`opened_orders()` before acting again rather than re-sending:
+
+```python
+summary = term.close_all(symbol="EURUSD", delete_pending=True)
+if summary.failed:
+    for r in summary.results:
+        if not r.success:
+            print(r.ticket, r.retcode, r.retcode_description)
+```
+
 Inputs are validated client-side before they're sent. One guard worth knowing:
 in `order_modify`, a literal `stop_loss=0.0` would *remove* your stop-loss, so
 it's rejected — pass `clear_stop_loss=True` to remove one deliberately, while

{fxsocket-0.3.0 → fxsocket-0.4.0}/src/fxsocket/__init__.py

@@ -42,6 +42,10 @@ from .models import (
     AccountInfo,
     AccountSummary,
     Candle,
+    CloseAllResult,
+    CloseAllSummary,
+    CommissionRule,
+    CommissionTier,
     Health,
     HealthChecks,
     HistoryTrade,
@@ -57,6 +61,7 @@ from .models import (
     SymbolInfo,
     TerminalStatusData,
     TradeEventData,
+    TradingSession,
 )
 from .terminal import (
     AccountUpdate,
@@ -112,8 +117,13 @@ __all__ = [
     "ServerTimezone",
     "Quote",
     "SymbolInfo",
+    "CommissionRule",
+    "CommissionTier",
+    "TradingSession",
     "Candle",
     "OrderResult",
+    "CloseAllResult",
+    "CloseAllSummary",
     "MarginCalc",
     "ProfitCalc",
     "Health",

fxsocket-0.4.0/src/fxsocket/_version.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

{fxsocket-0.3.0 → fxsocket-0.4.0}/src/fxsocket/models.py

@@ -21,7 +21,7 @@ from __future__ import annotations
 
 from datetime import datetime
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
 
 from .enums import OrderOutcome, Platform, TradingStatus
@@ -271,8 +271,65 @@ class Quote(_Camel):
     volume: int
 
 
+class CommissionTier(_Camel):
+    """One tier of a commission rule — a value and the volume/turnover range
+    it applies to.
+
+    Enum-like fields (``mode``, ``volume_type``) carry the raw MQL5 constant
+    names (e.g. ``SYMBOL_COMMISSION_MODE_MONEY``) so nothing is lost in
+    translation. ``range_to == 0`` means unbounded; ``min_value`` /
+    ``max_value`` cap the charged amount (0 = no cap).
+    """
+
+    mode: str
+    volume_type: str
+    value: float
+    min_value: float
+    max_value: float
+    range_from: float
+    range_to: float
+    currency: str
+
+
+class CommissionRule(_Camel):
+    """One broker commission rule for a symbol, as configured server-side
+    (MT5 ``SymbolInfoCommissions``).
+
+    A symbol can carry several rules; each has its own tiers. The mode fields
+    carry the MQL5 ``ENUM_SYMBOL_COMMISSION_*`` constant names verbatim.
+    """
+
+    currency: str
+    range_mode: str
+    charge_mode: str
+    entry_mode: str
+    direction_mode: str
+    profit_mode: str
+    tiers: list[CommissionTier] = []
+
+
+class TradingSession(_Camel):
+    """One trading-session window of a symbol, in *broker server time*.
+
+    ``day`` uses the MQL ``ENUM_DAY_OF_WEEK`` constant names (``SUNDAY`` …
+    ``SATURDAY``); times are ``HH:MM`` where ``24:00`` means end of day, so a
+    24-hour market shows ``00:00``–``24:00``.
+    """
+
+    day: str
+    from_: str = Field(alias="from")
+    to: str
+
+
 class SymbolInfo(_Camel):
-    """Contract specification for a symbol (``GET /SymbolInfo``)."""
+    """Contract specification for a symbol (``GET /SymbolInfo``).
+
+    ``commissions`` are the broker's commission rules straight from the
+    server's symbol specification; ``sessions`` are the per-weekday trading
+    windows in broker server time. Both default to empty on pods older than
+    bridge 0.10 (and ``commissions`` also when the broker publishes none or
+    the terminal predates the API — build 6060+).
+    """
 
     symbol: str
     description: str
@@ -295,6 +352,8 @@ class SymbolInfo(_Camel):
     currency_base: str
     currency_profit: str
     currency_margin: str
+    commissions: list[CommissionRule] = []
+    sessions: list[TradingSession] = []
 
 
 class Candle(_Camel):
@@ -360,6 +419,39 @@ class OrderResult(_Camel):
         return self.success or self.is_no_change
 
 
+class CloseAllResult(_Camel):
+    """One per-ticket outcome of a ``/CloseAll`` pass.
+
+    ``kind`` is ``"position"`` (closed) or ``"pending"`` (deleted).
+    """
+
+    ticket: int
+    kind: str
+    success: bool
+    retcode: int
+    retcode_description: str
+
+    @property
+    def is_pending(self) -> bool:
+        """True when this row is a deleted pending order (vs. a closed position)."""
+        return self.kind.lower() == "pending"
+
+
+class CloseAllSummary(_Camel):
+    """Reply of ``POST /CloseAll`` — every matched position (and pending
+    order, when ``delete_pending`` was set) with its close/delete outcome.
+
+    ``requested`` is how many orders the filters matched and were attempted;
+    ``closed`` how many attempts the broker accepted; ``failed`` how many it
+    rejected — inspect ``results`` for the per-ticket retcodes.
+    """
+
+    requested: int
+    closed: int
+    failed: int
+    results: list[CloseAllResult] = []
+
+
 class MarginCalc(_Camel):
     """Required margin for a hypothetical order (``GET /OrderCalcMargin``)."""
 
@@ -411,8 +503,17 @@ class AccountHealth(_Camel):
 
 
 class BridgeHealth(_Camel):
+    """Bridge section of ``/status``.
+
+    ``trade_ea_heartbeat_age_ms`` is how long ago the trade EA last made
+    dispatcher progress (``-1`` = never registered, or a pod older than
+    bridge 0.10). A large age while ``trade_ea_ready`` is still ``True``
+    means the EA is blocked in a long dealer call or dead — worth alerting on.
+    """
+
     version: str = ""
     trade_ea_ready: bool = False
+    trade_ea_heartbeat_age_ms: int = -1
     symbols_synced: bool = False
 
 

{fxsocket-0.3.0 → fxsocket-0.4.0}/src/fxsocket/terminal/client.py

@@ -46,6 +46,7 @@ from ..models import (
     AccountInfo,
     AccountSummary,
     Candle,
+    CloseAllSummary,
     Health,
     HealthChecks,
     HistoryTrade,
@@ -234,6 +235,20 @@ def _order_send_body(
     )
 
 
+def _close_all_body(
+    *, symbol: str | None, magic: int | None, delete_pending: bool
+) -> dict[str, Any]:
+    # magic=0 is a real filter (manually-opened orders) — only None is omitted.
+    # An empty dict is a valid body: it means "close everything".
+    return _clean(
+        {
+            "symbol": symbol,
+            "magic": magic,
+            "deletePending": True if delete_pending else None,
+        }
+    )
+
+
 def _order_modify_body(
     *,
     ticket: int,
@@ -481,6 +496,32 @@ class TerminalClient:
             self._http.request("POST", "/OrderClose", json=body)
         )
 
+    def close_all(
+        self,
+        *,
+        symbol: str | None = None,
+        magic: int | None = None,
+        delete_pending: bool = False,
+    ) -> CloseAllSummary:
+        """Close every open position in one trade-EA pass (``POST /CloseAll``).
+
+        Optionally filtered by ``symbol`` and/or ``magic`` (``magic=0``
+        matches manually-opened orders; ``None`` means no filter);
+        ``delete_pending=True`` also deletes matching pending orders. The
+        reply carries a per-ticket result for every attempted close/delete.
+
+        Positions opened while the pass is running are not covered, and on a
+        504 (:class:`~fxsocket.TerminalTimeoutError`) the pass *continues to
+        completion inside the terminal* — check :meth:`opened_orders` before
+        acting again rather than re-sending.
+        """
+        body = _close_all_body(
+            symbol=symbol, magic=magic, delete_pending=delete_pending
+        )
+        return CloseAllSummary.model_validate(
+            self._http.request("POST", "/CloseAll", json=body)
+        )
+
     # -- health ------------------------------------------------------------ #
 
     def status(self) -> Health:
@@ -732,6 +773,21 @@ class AsyncTerminalClient:
             await self._http.request("POST", "/OrderClose", json=body)
         )
 
+    async def close_all(
+        self,
+        *,
+        symbol: str | None = None,
+        magic: int | None = None,
+        delete_pending: bool = False,
+    ) -> CloseAllSummary:
+        """Async mirror of :meth:`TerminalClient.close_all`."""
+        body = _close_all_body(
+            symbol=symbol, magic=magic, delete_pending=delete_pending
+        )
+        return CloseAllSummary.model_validate(
+            await self._http.request("POST", "/CloseAll", json=body)
+        )
+
     async def status(self) -> Health:
         return Health.model_validate(await self._http.request("GET", "/status"))
 

{fxsocket-0.3.0 → fxsocket-0.4.0}/tests/test_private_servers.py

@@ -26,8 +26,8 @@ SERVER_ACCOUNT = {
     "server": "ICMarkets-Demo",
     "login": 7001,
     "status": "ready",
-    "rest_url": f"https://159.223.244.125/22222222-2222-2222-2222-222222222222",
-    "ws_url": f"wss://159.223.244.125/22222222-2222-2222-2222-222222222222/ws",
+    "rest_url": "https://159.223.244.125/22222222-2222-2222-2222-222222222222",
+    "ws_url": "wss://159.223.244.125/22222222-2222-2222-2222-222222222222/ws",
     "trade_ea_symbol": "",
     "created_at": "2026-07-16T08:00:00Z",
 }

{fxsocket-0.3.0 → fxsocket-0.4.0}/tests/test_terminal.py

@@ -212,6 +212,22 @@ def test_status_nested_health() -> None:
     assert h.terminal.ping_ms == 108
     assert h.account.logged_in is True
     assert h.bridge.trade_ea_ready is True
+    # Pre-0.10 bridges omit the heartbeat — defaults to -1 (never/unknown).
+    assert h.bridge.trade_ea_heartbeat_age_ms == -1
+
+
+def test_bridge_health_heartbeat_parses() -> None:
+    from fxsocket.models import BridgeHealth
+
+    b = BridgeHealth.model_validate(
+        {
+            "version": "0.10.0",
+            "tradeEaReady": True,
+            "tradeEaHeartbeatAgeMs": 8,
+            "symbolsSynced": True,
+        }
+    )
+    assert b.trade_ea_heartbeat_age_ms == 8
 
 
 # --------------------------------------------------------------------------- #
@@ -430,6 +446,76 @@ def test_order_modify_omits_unset_fields() -> None:
     }
 
 
+@respx.mock
+def test_close_all_sends_filters_and_parses() -> None:
+    route = respx.post(f"{TERM}/CloseAll").mock(
+        return_value=httpx.Response(
+            200,
+            json={
+                "requested": 2,
+                "closed": 1,
+                "failed": 1,
+                "results": [
+                    {
+                        "ticket": 100,
+                        "kind": "position",
+                        "success": True,
+                        "retcode": 10009,
+                        "retcodeDescription": "Done",
+                    },
+                    {
+                        "ticket": 101,
+                        "kind": "pending",
+                        "success": False,
+                        "retcode": 10006,
+                        "retcodeDescription": "Rejected",
+                    },
+                ],
+            },
+        )
+    )
+    with _term() as t:
+        summary = t.close_all(symbol="EURUSD", magic=0, delete_pending=True)
+    # magic=0 is a real filter (manual orders) and must be sent, not dropped.
+    assert json.loads(route.calls.last.request.content) == {
+        "symbol": "EURUSD",
+        "magic": 0,
+        "deletePending": True,
+    }
+    assert (summary.requested, summary.closed, summary.failed) == (2, 1, 1)
+    assert [r.is_pending for r in summary.results] == [False, True]
+    assert summary.results[1].retcode_description == "Rejected"
+
+
+@respx.mock
+def test_close_all_no_filters_sends_empty_json_body() -> None:
+    # /CloseAll requires a JSON body; with no filters it must be exactly {}.
+    route = respx.post(f"{TERM}/CloseAll").mock(
+        return_value=httpx.Response(
+            200, json={"requested": 0, "closed": 0, "failed": 0, "results": []}
+        )
+    )
+    with _term() as t:
+        summary = t.close_all()
+    req = route.calls.last.request
+    assert json.loads(req.content) == {}
+    assert req.headers["content-type"] == "application/json"
+    assert summary.requested == 0 and summary.results == []
+
+
+@respx.mock
+def test_close_all_504_maps_to_timeout() -> None:
+    # The pass continues inside the terminal after a 504 — the SDK must
+    # surface the timeout (never retry), so callers re-check /OpenedOrders.
+    respx.post(f"{TERM}/CloseAll").mock(
+        return_value=httpx.Response(
+            504, json={"error": "MRPC_TIMEOUT", "message": "timed out", "command_id": 3}
+        )
+    )
+    with _term() as t, pytest.raises(TerminalTimeoutError):
+        t.close_all()
+
+
 # --------------------------------------------------------------------------- #
 # Health probes — 503 carries a body, not an error
 # --------------------------------------------------------------------------- #
@@ -552,6 +638,46 @@ def test_symbol_info_parses_camelcase() -> None:
     assert si.tick_size == 0.00001
     assert si.volume_min == 0.01
     assert si.currency_base == "EUR"
+    # Pods older than bridge 0.10 omit commissions/sessions — default empty.
+    assert si.commissions == [] and si.sessions == []
+
+
+def test_symbol_info_commissions_and_sessions_parse() -> None:
+    from fxsocket import CommissionRule, TradingSession
+
+    rule = CommissionRule.model_validate(
+        {
+            "currency": "USD",
+            "rangeMode": "SYMBOL_COMMISSION_RANGE_VOLUME",
+            "chargeMode": "SYMBOL_COMMISSION_CHARGE_INSTANT",
+            "entryMode": "SYMBOL_COMMISSION_ENTRY_INOUT",
+            "directionMode": "SYMBOL_COMMISSION_DIRECTION_BOTH",
+            "profitMode": "SYMBOL_COMMISSION_PROFIT_ALL",
+            "tiers": [
+                {
+                    "mode": "SYMBOL_COMMISSION_MONEY_DEPOSIT",
+                    "volumeType": "SYMBOL_COMMISSION_VOLUME_TYPE_VOLUME",
+                    "value": 3.5,
+                    "minValue": 0.0,
+                    "maxValue": 0.0,
+                    "rangeFrom": 0.0,
+                    "rangeTo": 1000000.0,
+                    "currency": "USD",
+                }
+            ],
+        }
+    )
+    assert rule.range_mode == "SYMBOL_COMMISSION_RANGE_VOLUME"
+    assert rule.tiers[0].value == 3.5
+    assert rule.tiers[0].range_to == 1000000.0
+
+    # `from` is a Python keyword — the wire field maps to `from_`.
+    session = TradingSession.model_validate(
+        {"day": "FRIDAY", "from": "00:01", "to": "23:57"}
+    )
+    assert session.day == "FRIDAY"
+    assert session.from_ == "00:01"
+    assert session.to == "23:57"
 
 
 @respx.mock
@@ -721,3 +847,31 @@ async def test_async_order_send_body_and_validation() -> None:
         "volume": 0.2,
         "expertId": 7,
     }
+
+
+@respx.mock
+async def test_async_close_all() -> None:
+    route = respx.post(f"{TERM}/CloseAll").mock(
+        return_value=httpx.Response(
+            200,
+            json={
+                "requested": 1,
+                "closed": 1,
+                "failed": 0,
+                "results": [
+                    {
+                        "ticket": 100,
+                        "kind": "position",
+                        "success": True,
+                        "retcode": 10009,
+                        "retcodeDescription": "Done",
+                    }
+                ],
+            },
+        )
+    )
+    async with AsyncClient(api_key="fxs_live_k") as fx:
+        term = fx.terminal(_account())
+        summary = await term.close_all(symbol="EURUSD")
+    assert json.loads(route.calls.last.request.content) == {"symbol": "EURUSD"}
+    assert summary.closed == 1 and summary.results[0].success

fxsocket-0.3.0/src/fxsocket/_version.py

@@ -1 +0,0 @@
-__version__ = "0.3.0"