pipsocket 0.1.0__py3-none-any.whl

pipsocket/_generated/__init__.py

@@ -0,0 +1 @@
+# Generated by scripts/generate.py from openapi.json. Do not edit.

pipsocket/_generated/operations.py

@@ -0,0 +1,35 @@
+# Generated by scripts/generate.py from openapi.json. Do not edit.
+
+"""Every operation in the document: its id, method, path under the account and key."""
+
+from typing import Final, NamedTuple
+
+
+class Operation(NamedTuple):
+    id: str
+    method: str
+    path: str
+    keyed: bool
+
+
+OPERATIONS: Final[tuple[Operation, ...]] = (
+    Operation("account", "GET", "/", False),
+    Operation("pending_orders", "GET", "/orders", False),
+    Operation("place_order", "POST", "/orders", True),
+    Operation("check_order", "POST", "/orders/check", False),
+    Operation("modify_order", "PATCH", "/orders/{order}", True),
+    Operation("cancel_order", "DELETE", "/orders/{order}", True),
+    Operation("positions", "GET", "/positions", False),
+    Operation("set_position_levels", "PATCH", "/positions/{position}", True),
+    Operation("close_position", "POST", "/positions/{position}/close", True),
+    Operation("close_by", "POST", "/positions/{position}/close-by", True),
+    Operation("request", "GET", "/requests/{request}", False),
+    Operation("symbols", "GET", "/symbols", False),
+    Operation("symbol", "GET", "/symbols/{symbol}", False),
+    Operation("tick", "GET", "/symbols/{symbol}/tick", False),
+    Operation("history_deals", "GET", "/history/deals", False),
+    Operation("history_orders", "GET", "/history/orders", False),
+    Operation("kill_switch", "GET", "/kill-switch", False),
+    Operation("engage_kill_switch", "POST", "/kill-switch", False),
+    Operation("lift_kill_switch", "DELETE", "/kill-switch", False),
+)

pipsocket/_generated/tables.py

@@ -0,0 +1,95 @@
+# Generated by scripts/generate.py from openapi.json. Do not edit.
+
+"""Tables from the document's `x-pipsocket` extension and its request states."""
+
+from typing import Final
+
+# Every error code the API answers with, and its HTTP status.
+ERROR_STATUS: Final[dict[str, int]] = {
+    "missing_api_key": 401,
+    "invalid_api_key": 401,
+    "no_such_account": 404,
+    "no_such_order": 404,
+    "no_such_position": 404,
+    "no_such_request": 404,
+    "no_such_symbol": 404,
+    "invalid_request": 422,
+    "magic_reserved": 422,
+    "trade_rejected": 422,
+    "not_executed": 409,
+    "symbol_busy": 409,
+    "range_too_large": 422,
+    "kill_switch_engaged": 423,
+    "billing_hold": 423,
+    "account_not_connected": 503,
+    "bridge_outdated": 503,
+    "account_restarting": 503,
+    "not_sent": 503,
+    "bad_command": 503,
+    "terminal_error": 503,
+    "symbol_too_large": 503,
+    "no_price": 503,
+    "engine_busy": 503,
+    "engine_unavailable": 503,
+    "terminal_timeout": 504,
+    "engine_timeout": 504,
+}
+
+# MT5's retcodes: the name the API sends in `retcode_name`, and what it means.
+RETCODES: Final[dict[int, tuple[str, str]]] = {
+    0: ("OK", "The request passed the check."),
+    10004: ("TRADE_RETCODE_REQUOTE", "The broker requoted the price."),
+    10006: ("TRADE_RETCODE_REJECT", "The trade server rejected the request."),
+    10007: ("TRADE_RETCODE_CANCEL", "The request was cancelled by the trader."),
+    10008: ("TRADE_RETCODE_PLACED", "The order was placed; execution is not confirmed yet."),
+    10009: ("TRADE_RETCODE_DONE", "The request was completed."),
+    10010: ("TRADE_RETCODE_DONE_PARTIAL", "Only part of the request was completed."),
+    10011: ("TRADE_RETCODE_ERROR", "The trade server could not process the request."),
+    10012: ("TRADE_RETCODE_TIMEOUT", "The request was cancelled by a timeout."),
+    10013: ("TRADE_RETCODE_INVALID", "The request is invalid."),
+    10014: ("TRADE_RETCODE_INVALID_VOLUME", "The volume is invalid for this symbol."),
+    10015: ("TRADE_RETCODE_INVALID_PRICE", "The price is invalid."),
+    10016: ("TRADE_RETCODE_INVALID_STOPS", "The stop loss or take profit is invalid for this symbol or too close to the price."),
+    10017: ("TRADE_RETCODE_TRADE_DISABLED", "Trading is disabled."),
+    10018: ("TRADE_RETCODE_MARKET_CLOSED", "The market is closed."),
+    10019: ("TRADE_RETCODE_NO_MONEY", "There is not enough money for the request."),
+    10020: ("TRADE_RETCODE_PRICE_CHANGED", "The price changed."),
+    10021: ("TRADE_RETCODE_PRICE_OFF", "There are no quotes to process the request."),
+    10022: ("TRADE_RETCODE_INVALID_EXPIRATION", "The order expiration is invalid."),
+    10023: ("TRADE_RETCODE_ORDER_CHANGED", "The order changed state."),
+    10024: ("TRADE_RETCODE_TOO_MANY_REQUESTS", "Too many requests in a short time."),
+    10025: ("TRADE_RETCODE_NO_CHANGES", "The request changes nothing."),
+    10026: ("TRADE_RETCODE_SERVER_DISABLES_AT", "Automated trading is disabled by the server."),
+    10027: ("TRADE_RETCODE_CLIENT_DISABLES_AT", "Automated trading is disabled in the terminal."),
+    10028: ("TRADE_RETCODE_LOCKED", "The request is locked for processing."),
+    10029: ("TRADE_RETCODE_FROZEN", "The order or position is frozen."),
+    10030: ("TRADE_RETCODE_INVALID_FILL", "The filling mode is not allowed for this symbol."),
+    10031: ("TRADE_RETCODE_CONNECTION", "There is no connection to the trade server."),
+    10032: ("TRADE_RETCODE_ONLY_REAL", "This is only allowed for live accounts."),
+    10033: ("TRADE_RETCODE_LIMIT_ORDERS", "The account has reached its limit of pending orders."),
+    10034: ("TRADE_RETCODE_LIMIT_VOLUME", "The symbol has reached its volume limit for orders and positions."),
+    10035: ("TRADE_RETCODE_INVALID_ORDER", "The order type is incorrect or not allowed."),
+    10036: ("TRADE_RETCODE_POSITION_CLOSED", "The position is already closed."),
+    10038: ("TRADE_RETCODE_INVALID_CLOSE_VOLUME", "The close volume is more than the position's volume."),
+    10039: ("TRADE_RETCODE_CLOSE_ORDER_EXIST", "A close order already exists for the position."),
+    10040: ("TRADE_RETCODE_LIMIT_POSITIONS", "The account has reached its limit of open positions."),
+    10041: ("TRADE_RETCODE_REJECT_CANCEL", "The pending order's activation was rejected and the order cancelled."),
+    10042: ("TRADE_RETCODE_LONG_ONLY", "Only long positions are allowed for this symbol."),
+    10043: ("TRADE_RETCODE_SHORT_ONLY", "Only short positions are allowed for this symbol."),
+    10044: ("TRADE_RETCODE_CLOSE_ONLY", "Only closing positions is allowed for this symbol."),
+    10045: ("TRADE_RETCODE_FIFO_CLOSE", "Positions may only be closed first in, first out."),
+    10046: ("TRADE_RETCODE_HEDGE_PROHIBITED", "Opposite positions on one symbol are not allowed."),
+}
+
+# The states a recorded request can be in.
+REQUEST_STATES: Final[tuple[str, ...]] = (
+    "completed",
+    "placed",
+    "partial",
+    "rejected",
+    "pending",
+    "unknown",
+    "not_sent",
+    "not_executed",
+    "executed",
+)

pipsocket/_generated/types.py

@@ -0,0 +1,542 @@
+# Generated by scripts/generate.py from openapi.json. Do not edit.
+
+from __future__ import annotations
+from typing import TYPE_CHECKING, Literal, TypeAlias, TypedDict
+
+if TYPE_CHECKING:
+    from typing_extensions import NotRequired
+
+
+Action: TypeAlias = (
+    Literal["deal", "pending", "sltp", "modify", "remove", "close_by"] | str
+)
+
+
+class Blocking(TypedDict):
+    request: str
+    state: str
+
+
+class CheckResult(TypedDict):
+    passed: bool
+    retcode: int
+    retcode_name: (
+        Literal[
+            "OK",
+            "TRADE_RETCODE_REQUOTE",
+            "TRADE_RETCODE_REJECT",
+            "TRADE_RETCODE_CANCEL",
+            "TRADE_RETCODE_PLACED",
+            "TRADE_RETCODE_DONE",
+            "TRADE_RETCODE_DONE_PARTIAL",
+            "TRADE_RETCODE_ERROR",
+            "TRADE_RETCODE_TIMEOUT",
+            "TRADE_RETCODE_INVALID",
+            "TRADE_RETCODE_INVALID_VOLUME",
+            "TRADE_RETCODE_INVALID_PRICE",
+            "TRADE_RETCODE_INVALID_STOPS",
+            "TRADE_RETCODE_TRADE_DISABLED",
+            "TRADE_RETCODE_MARKET_CLOSED",
+            "TRADE_RETCODE_NO_MONEY",
+            "TRADE_RETCODE_PRICE_CHANGED",
+            "TRADE_RETCODE_PRICE_OFF",
+            "TRADE_RETCODE_INVALID_EXPIRATION",
+            "TRADE_RETCODE_ORDER_CHANGED",
+            "TRADE_RETCODE_TOO_MANY_REQUESTS",
+            "TRADE_RETCODE_NO_CHANGES",
+            "TRADE_RETCODE_SERVER_DISABLES_AT",
+            "TRADE_RETCODE_CLIENT_DISABLES_AT",
+            "TRADE_RETCODE_LOCKED",
+            "TRADE_RETCODE_FROZEN",
+            "TRADE_RETCODE_INVALID_FILL",
+            "TRADE_RETCODE_CONNECTION",
+            "TRADE_RETCODE_ONLY_REAL",
+            "TRADE_RETCODE_LIMIT_ORDERS",
+            "TRADE_RETCODE_LIMIT_VOLUME",
+            "TRADE_RETCODE_INVALID_ORDER",
+            "TRADE_RETCODE_POSITION_CLOSED",
+            "TRADE_RETCODE_INVALID_CLOSE_VOLUME",
+            "TRADE_RETCODE_CLOSE_ORDER_EXIST",
+            "TRADE_RETCODE_LIMIT_POSITIONS",
+            "TRADE_RETCODE_REJECT_CANCEL",
+            "TRADE_RETCODE_LONG_ONLY",
+            "TRADE_RETCODE_SHORT_ONLY",
+            "TRADE_RETCODE_CLOSE_ONLY",
+            "TRADE_RETCODE_FIFO_CLOSE",
+            "TRADE_RETCODE_HEDGE_PROHIBITED",
+            "UNKNOWN",
+        ]
+        | str
+    )
+    comment: str
+    balance: float
+    equity: float
+    profit: float
+    margin: float
+    margin_free: float
+    margin_level: float
+
+
+class CloseBy(TypedDict):
+    position_by: int
+
+
+class DealView(TypedDict):
+    ticket: int
+    order: int
+    position: int
+    symbol: str
+    type: NotRequired[
+        Literal[
+            "buy",
+            "sell",
+            "balance",
+            "credit",
+            "charge",
+            "correction",
+            "bonus",
+            "commission",
+            "commission_daily",
+            "commission_monthly",
+            "commission_agent_daily",
+            "commission_agent_monthly",
+            "interest",
+            "buy_canceled",
+            "sell_canceled",
+            "dividend",
+            "dividend_franked",
+            "tax",
+        ]
+        | str
+        | None
+    ]
+    entry: Literal["in", "out", "inout", "out_by"] | str
+    reason: (
+        Literal["client", "mobile", "web", "expert", "sl", "tp", "so", "other"] | str
+    )
+    volume: float
+    price: float
+    profit: float
+    commission: float
+    swap: float
+    fee: float
+    magic: int
+    comment: str
+    time_msc: int
+
+
+class EngageKillSwitch(TypedDict):
+    deviation: NotRequired[int | None]
+
+
+class ErrorBody(TypedDict):
+    error: str
+    message: str
+
+
+Filling: TypeAlias = Literal["fok", "ioc", "return", "boc"] | str
+
+
+class HandSettlement(TypedDict):
+    outcome: str
+    settled_by: str
+    reason: str
+
+
+class KillSwitchView(TypedDict):
+    engaged: bool
+    since: NotRequired[int | None]
+    deviation: NotRequired[int | None]
+
+
+OrderType: TypeAlias = (
+    Literal[
+        "buy",
+        "sell",
+        "buy_limit",
+        "sell_limit",
+        "buy_stop",
+        "sell_stop",
+        "buy_stop_limit",
+        "sell_stop_limit",
+        "close_by",
+    ]
+    | str
+)
+
+
+class PendingOrderView(TypedDict):
+    ticket: int
+    symbol: str
+    type: NotRequired[OrderType | None]
+    volume_initial: float
+    volume_current: float
+    price_open: float
+    sl: float
+    tp: float
+    magic: int
+    comment: str
+    position: int
+
+
+class PositionLevels(TypedDict):
+    sl: float
+    tp: float
+
+
+class PositionView(TypedDict):
+    ticket: int
+    identifier: int
+    symbol: str
+    type: Literal["buy", "sell"] | str
+    volume: float
+    price_open: float
+    sl: float
+    tp: float
+    magic: int
+    comment: str
+    time_msc: int
+
+
+class Remaining(TypedDict):
+    positions: int
+    orders: int
+
+
+RequestState: TypeAlias = (
+    Literal[
+        "completed",
+        "placed",
+        "partial",
+        "rejected",
+        "pending",
+        "unknown",
+        "not_sent",
+        "not_executed",
+        "executed",
+    ]
+    | str
+)
+
+
+Settlement: TypeAlias = Literal["evidence", "operator"] | str
+
+
+class SymbolBusy(TypedDict):
+    error: str
+    message: str
+    not_sent: bool
+    blocking: list[Blocking]
+
+
+class SymbolSummaryView(TypedDict):
+    name: str
+    description: str
+    path: str
+    available: bool
+    digits: int
+    contract_size: float
+    currency_base: str
+    currency_profit: str
+    currency_margin: str
+    trading: NotRequired[
+        Literal["disabled", "long_only", "short_only", "close_only", "full"]
+        | str
+        | None
+    ]
+    volume_min: float
+    volume_max: float
+    volume_step: float
+    in_market_watch: bool
+
+
+class SymbolView(TypedDict):
+    name: str
+    available: bool
+    description: str
+    digits: int
+    point: float
+    tick_size: float
+    tick_value: float
+    contract_size: float
+    volume_min: float
+    volume_max: float
+    volume_step: float
+    stops_level: int
+    freeze_level: int
+    filling_mode: int
+    trade_mode: int
+    execution_mode: int
+    order_mode: int
+    expiration_mode: int
+    currency_base: str
+    currency_profit: str
+    currency_margin: str
+    filling_modes: list[Literal["fok", "ioc", "boc"] | str]
+    execution: NotRequired[
+        Literal["request", "instant", "market", "exchange"] | str | None
+    ]
+    order_types: list[
+        Literal["market", "limit", "stop", "stop_limit", "sl", "tp", "close_by"] | str
+    ]
+    expirations: list[Literal["gtc", "day", "specified", "specified_day"] | str]
+    trading: NotRequired[
+        Literal["disabled", "long_only", "short_only", "close_only", "full"]
+        | str
+        | None
+    ]
+
+
+class TickView(TypedDict):
+    symbol: str
+    bid: float
+    ask: float
+    time_msc: NotRequired[int | None]
+    last: NotRequired[float | None]
+    volume: NotRequired[float | None]
+    flags: NotRequired[int | None]
+
+
+class TradeResult(TypedDict):
+    retcode: int
+    retcode_name: (
+        Literal[
+            "OK",
+            "TRADE_RETCODE_REQUOTE",
+            "TRADE_RETCODE_REJECT",
+            "TRADE_RETCODE_CANCEL",
+            "TRADE_RETCODE_PLACED",
+            "TRADE_RETCODE_DONE",
+            "TRADE_RETCODE_DONE_PARTIAL",
+            "TRADE_RETCODE_ERROR",
+            "TRADE_RETCODE_TIMEOUT",
+            "TRADE_RETCODE_INVALID",
+            "TRADE_RETCODE_INVALID_VOLUME",
+            "TRADE_RETCODE_INVALID_PRICE",
+            "TRADE_RETCODE_INVALID_STOPS",
+            "TRADE_RETCODE_TRADE_DISABLED",
+            "TRADE_RETCODE_MARKET_CLOSED",
+            "TRADE_RETCODE_NO_MONEY",
+            "TRADE_RETCODE_PRICE_CHANGED",
+            "TRADE_RETCODE_PRICE_OFF",
+            "TRADE_RETCODE_INVALID_EXPIRATION",
+            "TRADE_RETCODE_ORDER_CHANGED",
+            "TRADE_RETCODE_TOO_MANY_REQUESTS",
+            "TRADE_RETCODE_NO_CHANGES",
+            "TRADE_RETCODE_SERVER_DISABLES_AT",
+            "TRADE_RETCODE_CLIENT_DISABLES_AT",
+            "TRADE_RETCODE_LOCKED",
+            "TRADE_RETCODE_FROZEN",
+            "TRADE_RETCODE_INVALID_FILL",
+            "TRADE_RETCODE_CONNECTION",
+            "TRADE_RETCODE_ONLY_REAL",
+            "TRADE_RETCODE_LIMIT_ORDERS",
+            "TRADE_RETCODE_LIMIT_VOLUME",
+            "TRADE_RETCODE_INVALID_ORDER",
+            "TRADE_RETCODE_POSITION_CLOSED",
+            "TRADE_RETCODE_INVALID_CLOSE_VOLUME",
+            "TRADE_RETCODE_CLOSE_ORDER_EXIST",
+            "TRADE_RETCODE_LIMIT_POSITIONS",
+            "TRADE_RETCODE_REJECT_CANCEL",
+            "TRADE_RETCODE_LONG_ONLY",
+            "TRADE_RETCODE_SHORT_ONLY",
+            "TRADE_RETCODE_CLOSE_ONLY",
+            "TRADE_RETCODE_FIFO_CLOSE",
+            "TRADE_RETCODE_HEDGE_PROHIBITED",
+            "UNKNOWN",
+        ]
+        | str
+    )
+    comment: str
+    order: int
+    deal: int
+    position: int
+    volume: float
+    price: float
+    bid: float
+    ask: float
+    retcode_external: int
+
+
+TypeTime: TypeAlias = Literal["gtc", "day", "specified", "specified_day"] | str
+
+
+class SentRequest(TypedDict):
+    action: Action
+    symbol: str
+    type: OrderType
+    volume: float
+    price: float
+    stoplimit: float
+    sl: float
+    tp: float
+    deviation: int
+    type_filling: Filling
+    type_time: TypeTime
+    expiration: int
+    order: int
+    position: int
+    position_by: int
+    magic: int
+    comment: str
+
+
+FillingParam: TypeAlias = Literal["fok", "ioc", "return", "boc"]
+
+
+OrderTypeParam: TypeAlias = Literal[
+    "buy",
+    "sell",
+    "buy_limit",
+    "sell_limit",
+    "buy_stop",
+    "sell_stop",
+    "buy_stop_limit",
+    "sell_stop_limit",
+    "close_by",
+]
+
+
+TypeTimeParam: TypeAlias = Literal["gtc", "day", "specified", "specified_day"]
+
+
+class AccountView(TypedDict):
+    id: str
+    login: int
+    server: str
+    status: str
+    connected: bool
+    trade_allowed: NotRequired[bool | None]
+    company: NotRequired[str | None]
+    currency: NotRequired[str | None]
+    leverage: NotRequired[int | None]
+    margin_mode: NotRequired[str | None]
+    trade_mode: NotRequired[str | None]
+    balance: NotRequired[float | None]
+    equity: NotRequired[float | None]
+    credit: NotRequired[float | None]
+    margin: NotRequired[float | None]
+    margin_free: NotRequired[float | None]
+    server_time: NotRequired[int | None]
+    kill_switch: KillSwitchView
+
+
+class CheckView(TypedDict):
+    sent: SentRequest
+    result: CheckResult
+    message: str
+
+
+class ClosePosition(TypedDict):
+    volume: float
+    type_filling: FillingParam
+    price: NotRequired[float | None]
+    deviation: NotRequired[int | None]
+    magic: NotRequired[int | None]
+    comment: NotRequired[str | None]
+
+
+class HistoryOrderView(TypedDict):
+    ticket: int
+    symbol: str
+    type: NotRequired[OrderType | None]
+    state: NotRequired[
+        Literal[
+            "started",
+            "placed",
+            "canceled",
+            "partial",
+            "filled",
+            "rejected",
+            "expired",
+            "request_add",
+            "request_modify",
+            "request_cancel",
+        ]
+        | str
+        | None
+    ]
+    volume_initial: float
+    volume_current: float
+    price_open: float
+    magic: int
+    comment: str
+    position: int
+    time_setup_msc: int
+    time_done_msc: int
+
+
+class KillSwitchNotConnected(TypedDict):
+    error: str
+    kill_switch: KillSwitchView
+    message: str
+
+
+KillSwitchUnavailable: TypeAlias = ErrorBody | KillSwitchNotConnected
+
+
+class ModifyOrder(TypedDict):
+    price: float
+    sl: float
+    tp: float
+    type_time: TypeTimeParam
+    stoplimit: NotRequired[float | None]
+    expiration: NotRequired[int | None]
+
+
+class PlaceOrder(TypedDict):
+    symbol: str
+    type: OrderTypeParam
+    volume: float
+    type_filling: FillingParam
+    price: NotRequired[float | None]
+    stoplimit: NotRequired[float | None]
+    sl: NotRequired[float | None]
+    tp: NotRequired[float | None]
+    deviation: NotRequired[int | None]
+    type_time: NotRequired[TypeTimeParam | None]
+    expiration: NotRequired[int | None]
+    magic: NotRequired[int | None]
+    comment: NotRequired[str | None]
+
+
+RequestResult: TypeAlias = TradeResult | ErrorBody | HandSettlement
+
+
+class RequestView(TypedDict):
+    request: str
+    state: RequestState
+    sent: SentRequest
+    result: NotRequired[RequestResult | None]
+    message: str
+    error: NotRequired[str | None]
+    settlement: NotRequired[Settlement | None]
+
+
+class SweptOrder(TypedDict):
+    order: int
+    request: RequestView
+
+
+class SweptPosition(TypedDict):
+    position: int
+    request: RequestView
+
+
+TradeConflict: TypeAlias = SymbolBusy | RequestView
+
+
+TradeRejected: TypeAlias = ErrorBody | RequestView
+
+
+TradeUnavailable: TypeAlias = ErrorBody | RequestView
+
+
+class KillSwitchOutcome(TypedDict):
+    flat: bool
+    cancelled: list[SweptOrder]
+    closed: list[SweptPosition]
+    remaining: NotRequired[Remaining | None]
+    unanswered: list[str]
+    kill_switch: KillSwitchView
+    message: str