pipsocket 0.1.0__py3-none-any.whl

pipsocket/types.py

@@ -0,0 +1,48 @@
+"""The API's answer and request types, generated from its OpenAPI document.
+
+Answers are plain dicts; these TypedDicts describe them for type checkers and editors. Nothing
+is checked at run time, so a field or value a newer API adds is passed through as it is. Enums
+in answers are open (a known value or any other string), enums in requests closed: the closed
+copy of an enum used on both sides has the suffix "Param".
+"""
+
+from ._generated.types import (
+    AccountView as AccountView,
+    Action as Action,
+    Blocking as Blocking,
+    CheckResult as CheckResult,
+    CheckView as CheckView,
+    CloseBy as CloseBy,
+    ClosePosition as ClosePosition,
+    DealView as DealView,
+    EngageKillSwitch as EngageKillSwitch,
+    ErrorBody as ErrorBody,
+    Filling as Filling,
+    FillingParam as FillingParam,
+    HandSettlement as HandSettlement,
+    HistoryOrderView as HistoryOrderView,
+    KillSwitchNotConnected as KillSwitchNotConnected,
+    KillSwitchOutcome as KillSwitchOutcome,
+    KillSwitchView as KillSwitchView,
+    ModifyOrder as ModifyOrder,
+    OrderType as OrderType,
+    OrderTypeParam as OrderTypeParam,
+    PendingOrderView as PendingOrderView,
+    PlaceOrder as PlaceOrder,
+    PositionLevels as PositionLevels,
+    PositionView as PositionView,
+    Remaining as Remaining,
+    RequestResult as RequestResult,
+    RequestState as RequestState,
+    RequestView as RequestView,
+    SentRequest as SentRequest,
+    Settlement as Settlement,
+    SweptOrder as SweptOrder,
+    SweptPosition as SweptPosition,
+    SymbolSummaryView as SymbolSummaryView,
+    SymbolView as SymbolView,
+    TickView as TickView,
+    TradeResult as TradeResult,
+    TypeTime as TypeTime,
+    TypeTimeParam as TypeTimeParam,
+)

pipsocket-0.1.0.dist-info/METADATA

@@ -0,0 +1,358 @@
+Metadata-Version: 2.5
+Name: pipsocket
+Version: 0.1.0
+Summary: Python client for the Pipsocket API: trade MetaTrader 5 accounts hosted by Pipsocket from Linux, macOS or Windows.
+Project-URL: Homepage, https://pipsocket.com
+Project-URL: Documentation, https://docs.pipsocket.com
+Project-URL: Source, https://github.com/pipsocket/pipsocket-python
+Project-URL: Changelog, https://github.com/pipsocket/pipsocket-python/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/pipsocket/pipsocket-python/issues
+Author-email: Pipsocket <support@pipsocket.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: algotrading,api-client,forex,pipsocket,trading,trading-api,websocket
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: websockets<18,>=16.1
+Description-Content-Type: text/markdown
+
+# pipsocket
+
+Python client for the Pipsocket API: trade MetaTrader 5 accounts hosted by Pipsocket from Linux,
+macOS or Windows.
+
+## Why
+
+The terminal runs at Pipsocket, so your code runs anywhere Python does: one `pip install`, no
+terminal on your machine, and typed answers.
+
+| | The MetaTrader5 package | pipsocket |
+| --- | --- | --- |
+| Runs on | Windows only (its wheels on PyPI are all `win_amd64`, checked 9 Nov 2026) | Linux, macOS, Windows |
+| Needs | An MT5 terminal running on the same machine | A Pipsocket account; the terminal is hosted |
+
+## Install
+
+```bash
+pip install pipsocket
+```
+
+Python 3.10 or later. Its dependencies are [httpx](https://www.python-httpx.org) and
+[websockets](https://websockets.readthedocs.io).
+
+## Quickstart
+
+Make your workspace's API key on the dashboard's **API key** page, where your accounts' ids are
+listed too, and put the key in `PIPSOCKET_KEY`. Use a demo account while you try things.
+
+Each symbol allows its own filling modes, and MT5 rejects an order with any other (retcode
+10030), so read them, and the smallest volume, from the symbol rather than assuming one:
+
+```python
+from pipsocket import Pipsocket
+
+ps = Pipsocket()  # reads PIPSOCKET_KEY
+acct = ps.account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+
+print(acct.get()["balance"])
+eurusd = acct.symbols.get("EURUSD")
+filling = eurusd["filling_modes"][0]  # one the symbol allows
+volume = eurusd["volume_min"]
+
+order = acct.orders.place(symbol="EURUSD", type="buy", volume=volume, type_filling=filling)
+if order.outstanding:  # pending or unknown: it may still execute
+    order = acct.requests.wait(order.id)
+
+if order.accepted and order.result["deal"]:  # MT5 took it and made a deal: filled
+    print("filled:", order.result["deal"], "at", order.result["price"])
+    # On a hedging account the position's ticket is the order's.
+    position = order.result["position"] or order.result["order"]
+    closed = acct.positions.close(position, volume=volume, type_filling=filling)
+    print("closed:", closed.state)
+elif order.state == "rejected":
+    print("rejected:", order.retcode_name)
+else:
+    print(order.state, order.message)
+```
+
+Answers are plain dicts, typed with `TypedDict`s from the API's OpenAPI document
+(`pipsocket.types`), so they go straight into anything that takes dicts:
+
+```python
+from pipsocket import Pipsocket
+
+acct = Pipsocket().account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+
+# History ranges are the broker's server time in seconds, both ends included, not UTC: take
+# them from the account's server_time (None until its terminal has reported).
+now = acct.get()["server_time"]
+if now is not None:
+    deals = acct.history.deals(now - 86400, now)  # the last 24 hours
+    profit = sum(deal["profit"] for deal in deals)
+    print(len(deals), "deals,", profit)
+```
+
+## Order outcomes
+
+Each trade call (`orders.place`, `orders.modify`, `orders.cancel`, `positions.close`,
+`positions.close_by`, `positions.set_levels`) is one MT5 trade request, sent once and recorded as
+a request (`req_...`). The call returns that request as a `TradeRequest`, **whatever its state**:
+a rejection is a result, not an exception. `acct.requests.get(id)` looks one up, and
+`acct.requests.wait(id, timeout=30)` looks it up until it is final or the time is up, then
+returns it as it stands; it never raises for "still pending" and never sends anything.
+
+A `TradeRequest` has `id`, `state`, `sent`, `result`, `message`, `error`, `settlement`, the
+whole body as `raw`, the `idempotency_key` it was sent with and the `http_status`, plus
+`accepted`, `final`, `outstanding`, `retcode` and `retcode_name`.
+
+```python
+from pipsocket import Pipsocket
+
+acct = Pipsocket().account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+
+request = acct.requests.get("req_5f0c2a9e41d7b3a8c6e2f190")
+match request.state:
+    case "completed" | "placed" | "partial":
+        if request.result["deal"]:
+            print("filled: deal", request.result["deal"])
+        else:  # a pending order placed, or a change made: no deal
+            print("done, no deal: order", request.result["order"])
+    case "rejected":
+        print("MT5 rejected it:", request.retcode, request.retcode_name)
+    case "pending" | "unknown":
+        print("no outcome yet: it may still execute")
+    case _:
+        print(request.state, request.message)
+```
+
+| `state` | Meaning |
+| --- | --- |
+| `completed` | MT5 completed the request (retcode 10009). Not necessarily a fill: see below. Final. |
+| `placed` | MT5 placed it (retcode 10008), such as a pending order. Final. |
+| `partial` | MT5 completed part of it (retcode 10010). Final. |
+| `rejected` | MT5 rejected it: `retcode` says why. Final. |
+| `pending` | Sent, no answer from the trade server yet. Never sent again. |
+| `unknown` | No answer within 130 seconds: it may have executed. Settled by proof only. |
+| `not_sent` | The terminal didn't send it: `result["error"]` says why. Final. |
+| `not_executed` | Was `unknown`, settled as never executed (`settlement` says by whom). Final. |
+| `executed` | Was `unknown`, settled as executed by the account's owner. Final. |
+
+`completed` means MT5 completed the request, whatever it was: a market order filled, but also a
+pending order placed, an order modified or cancelled, or stops set. So `accepted` (completed,
+placed or partial) says MT5 took the request, not that anything filled. A fill shows as a deal:
+`result["deal"]` is non-zero (and `sent["action"]` is `"deal"`). A pending order that was placed
+has `result["order"]` set and `result["deal"]` 0.
+
+`raise_for_state()` raises `TradeNotAccepted` for `rejected`, `not_sent` and `not_executed`, for
+those who prefer exceptions. `orders.check(...)` is MT5's dry run of an order and sends nothing to
+the broker. A state this SDK doesn't know yet comes through as its string,
+neither accepted nor final. See [Errors and retcodes](https://docs.pipsocket.com/errors).
+
+## Streaming
+
+`acct.stream(...)` keeps the account's WebSocket open: requests settling, deals, prices and the
+account as they happen, reconnected for you.
+
+```python
+from pipsocket import Pipsocket, TradeRequest
+
+acct = Pipsocket().account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+
+with acct.stream(ticks=["EURUSD"]) as events:
+    for event in events:
+        match event["type"]:
+            case "resync":  # after every (re)connection or gap: a new baseline
+                print("resync:", event["reason"], len(event["positions"] or []), "positions")
+            case "tick":
+                print(event["symbol"], event["bid"], event["ask"])
+            case "request":
+                print("settled:", TradeRequest.from_event(event).state)
+                break
+```
+
+Events are the API's messages as they are (see [the WebSocket stream](https://docs.pipsocket.com/websocket)),
+plus one the SDK adds, `resync`. The helper sends the tick set again after every reconnect,
+answers the keep-alive, and resyncs when the socket was closed, the stream said `lagged`, the
+account's host came back, or your code fell behind (`reason`: `connected`, `reconnected`,
+`lagged`, `host_back`, `overflow`).
+
+What a `resync` gives:
+
+- **A new baseline**: `account`, `positions` and `orders` read over REST after the stream was
+  live. Replace your own state with it. `positions` and `orders` are `None` when the terminal
+  isn't running, which is not the same as empty.
+- **History since the last checkpoint**, best effort: `history` has the `deals` and `orders` from
+  the broker's server time `from` to `to`, or is `None` with `history_reason` saying why
+  (`no_checkpoint`, `account_changed`, `range_too_large` or `unavailable`).
+- Every deal, request, transaction and status event from then on, delivered after it.
+
+What it doesn't give: one moment in time (the reads happen one after another), an order between
+events and the snapshot (events are notices, not deltas: never add them to the snapshot), or the
+events from a gap. **Events that happened while the stream was away are not replayed**, `request`
+events included: the resync's snapshot and `history` cover what changed, and for a request you
+are waiting on, `acct.requests.wait(id)` looks it up over REST. Ticks and transaction events from
+a gap are gone. Deduplicate deals and orders by ticket and requests by id, and read again when
+exact state matters. `snapshot=False` sends `resync` without reading anything.
+
+A resync's `history` starts 5 minutes before its checkpoint (the newest broker time the stream
+delivered), so it can include deals from before you opened the stream; deals the stream already
+delivered as events are left out of it.
+
+The sync iterator (`for event in events`) blocks until an event arrives. To stop it, break out of
+the loop, or call `events.close()` from another thread: iteration then ends at once, and events
+still queued are not delivered. `AsyncPipsocket` has the same helper, with `async with` and
+`async for`, where cancelling the task stops it too.
+
+While a stream is open on an account handle, `acct.requests.wait(id)` ends as soon as the stream
+sees the request settle.
+
+## Errors, retries and idempotency keys
+
+An exception means there is no recorded request in hand. Every exception derives from
+`PipsocketError`. A refusal from the API is an `APIError` with `status`, `code` (the API's
+`error`), `message`, `body` and `raw`, and a subclass for each kind: `AuthenticationError`,
+`NotFound`, `InvalidRequest`, `SymbolBusy`, `KillSwitchEngaged`, `BillingHold`,
+`AccountUnavailable`, `EngineBusy`, `Unavailable`, `TerminalTimeout`, `TerminalError`, `NoPrice`
+and the rest. A network failure is an `APIConnectionError` (or `APITimeoutError`). None of
+these, raised from a trade call, means anything was sent, with one exception:
+
+**`OutcomeUnknown`** means the trade may have reached the account's host and no answer came
+back. It may have executed. It carries the `idempotency_key` the call sent and the last error as
+`cause`. Call again with the same key: you get the recorded request if there is one, and the
+trade is sent if it never arrived. Or read positions and history first.
+
+Every trade call sends an `Idempotency-Key`: a new one per call, the same one on every retry
+inside the call. Calls that fail in a way worth repeating (the host busy or away, a dropped
+connection, an answer that isn't the API's JSON, `symbol_busy` with `Retry-After`) are tried
+again, twice by default, waiting 0.5 s and then 1 s (or what `Retry-After` says), and no new
+attempt starts 60 seconds after the first: a market order sent minutes late is not what you
+asked for. Refusals that won't change, such as a bad key or `kill_switch_engaged`, are raised at
+once.
+
+To survive a crash or a cancellation, make the key yourself and save it before sending. After a
+restart, the same call with the same key returns the recorded request instead of trading again.
+Make a new key for every new trade, and never build one from the order's fields (such as
+"buy-eurusd"): the key is the whole match, so a second order with the same key returns the first
+one and sends nothing.
+
+A key protects a trade only while Pipsocket keeps its request: until 7 days after its outcome is
+known. After that the same key sends a new trade. So resolve a journal's open entries promptly,
+and never replay an old one blindly: check positions and history first.
+
+```python
+import json
+import pathlib
+
+import pipsocket
+from pipsocket import OutcomeUnknown, Pipsocket
+
+acct = Pipsocket().account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+journal = pathlib.Path("orders.jsonl")
+
+
+def note(entry: dict[str, object]) -> None:
+    with journal.open("a") as file:
+        file.write(json.dumps(entry) + "\n")
+
+
+eurusd = acct.symbols.get("EURUSD")
+filling, volume = eurusd["filling_modes"][0], eurusd["volume_min"]
+key = pipsocket.new_key()
+note({"key": key, "symbol": "EURUSD", "volume": volume})  # saved before it is sent
+
+try:
+    order = acct.orders.place(
+        symbol="EURUSD", type="buy", volume=volume, type_filling=filling, idempotency_key=key
+    )
+except OutcomeUnknown as error:
+    # The entry stays open: after a restart, resolve it with the same key.
+    print("may have executed; call again with", error.idempotency_key)
+else:
+    if order.final:
+        note({"key": key, "request": order.id, "state": order.state})  # resolved
+    else:
+        print("no outcome yet: wait for", order.id, "before closing the entry")
+    print(order.id, order.state)
+```
+
+Timeouts and retries can be set on the client, or per call:
+
+```python
+from pipsocket import Pipsocket
+
+ps = Pipsocket(timeout=20, max_retries=4, retry_deadline=30)  # timeout is per attempt
+acct = ps.account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+print(acct.kill_switch.get(max_retries=0)["engaged"])
+```
+
+The kill switch closes every position and cancels every pending order, and refuses new exposure
+until it is lifted. Engaging it again retries whatever is left:
+
+```python
+from pipsocket import AccountUnavailable, Pipsocket
+
+acct = Pipsocket().account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+try:
+    outcome = acct.kill_switch.engage(deviation=20)
+    print("flat:", outcome["flat"])
+except AccountUnavailable as error:
+    print("engaged, but the terminal didn't answer:", error.kill_switch)
+```
+
+## Sync and async
+
+`Pipsocket` is synchronous; `AsyncPipsocket` has the same calls, awaited.
+
+```python
+import asyncio
+
+from pipsocket import AsyncPipsocket
+
+
+async def main() -> None:
+    async with AsyncPipsocket() as ps:
+        acct = ps.account("acc_01m6tx3k9f2qw8r7bznd5yvh4c")
+        account, positions = await asyncio.gather(acct.get(), acct.positions.list())
+        print(account["equity"], len(positions))
+
+
+asyncio.run(main())
+```
+
+Keep the key on your server: the API doesn't answer browsers, and the key is never logged or put
+in an error message by this SDK.
+
+## Links
+
+- Docs: [Quickstart](https://docs.pipsocket.com/quickstart),
+  [API reference](https://docs.pipsocket.com/api/place-an-order),
+  [WebSocket stream](https://docs.pipsocket.com/websocket),
+  [Errors and retcodes](https://docs.pipsocket.com/errors)
+- [MCP server](https://docs.pipsocket.com/mcp) for AI apps
+- [Changelog](CHANGELOG.md)
+
+## Versioning and support
+
+Versions follow semver and are 0.x for now: until 1.0, a minor release (0.2, 0.3) may change
+the API of this SDK, and the changelog says how. Report bugs in this SDK on
+[GitHub issues](https://github.com/pipsocket/pipsocket-python/issues). Questions about your account
+or billing go to [support@pipsocket.com](mailto:support@pipsocket.com).
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).
+
+MetaTrader is a trademark of MetaQuotes Ltd. Pipsocket is not affiliated with MetaQuotes.

pipsocket-0.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+pipsocket/__init__.py,sha256=pZ2pLGe0ExQMsTfbmsBLycuBljBv47uMsCemOC8sWY4,1414
+pipsocket/_core.py,sha256=JDWjIO49Y-e_MwBzUnpbp99n8rRpBg_rvJHoOvpKa0k,24741
+pipsocket/_http.py,sha256=3ZNzC62okAr6QPe0_4gdEe1qMgQVeSDcrnzKsysOe34,8478
+pipsocket/_stream_core.py,sha256=v-VXoI54sFN6o9gbD7bRpDg_UR3AMuJrq-RMMBYxKBs,31680
+pipsocket/_version.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
+pipsocket/aio.py,sha256=uR1TBxiv5G9onC5SxtHoULSOHJhLFKi1o6gRbGpsrhU,26815
+pipsocket/client.py,sha256=2LA99SyxO-6KP_p4PIGmxqeNgBoh_pVDXsPVDN6fyDQ,25358
+pipsocket/errors.py,sha256=f16_-DpeYJH13IREENc25Fb8ZYYPwgBLOV2ngmhNs8M,8734
+pipsocket/models.py,sha256=zQj25D569LGjxfWNdRjEBHebDb0b_WmCy4G2dztEztA,5758
+pipsocket/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pipsocket/stream.py,sha256=YeZi2qI2gp8s4_aWPAkiAnsP2-7XpgP1RQrbihIQWb8,25907
+pipsocket/types.py,sha256=U6ecHjhpQvfLKoAg09bX9tZiM8x8FM9G-JkDAH1sXlo,1723
+pipsocket/_generated/__init__.py,sha256=F3JxYZhP_J8MH26ydHmC1vXLWyxZ7CjsSuVNJREtauY,67
+pipsocket/_generated/operations.py,sha256=5v0GBfE16IKgR6IneNhQ_90gKjw2bFyCig35FpvrcTs,1533
+pipsocket/_generated/tables.py,sha256=AJ2SJujRA46rtM4L0XOUy-ZmpJfBb4BoTt88CsJgqrk,5009
+pipsocket/_generated/types.py,sha256=cP__ETYwmSd6KYpW8MLEQ7lMQpFexwMfiatRab5MZEU,12824
+pipsocket-0.1.0.dist-info/METADATA,sha256=5y31vdpXWxUjXhtJUsk4SiK8iElY0AHYfkrI5b7Sf18,16016
+pipsocket-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+pipsocket-0.1.0.dist-info/licenses/LICENSE,sha256=gd_IFd70HOl6rg-nnzpEjHD-8vcuM-HQwTNHrD3R8ik,1088
+pipsocket-0.1.0.dist-info/RECORD,,

pipsocket-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pipsocket-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Wilier Labs Pty Ltd (Pipsocket)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.