pmt5api 1.0.0__py3-none-any.whl

pmt5api/docs/API.md

@@ -0,0 +1,717 @@
+# pmt5api — API reference
+
+Generated from the code (`tools/gen_docs.py`); do not edit by hand. Times are naive `datetime` values in the broker's server time. Every call that needs a connection raises `NotConnectedError` when there is none, and every error is a subclass of `pmt5api.WmtError`.
+
+## Constructing a client
+
+```python
+Client(login, password, host, port=443, *, api_key=None, token_url=None, dll_path=None, connect_timeout=None, cluster_member_timeout=None, token_timeout=None, execution_timeout=None, quote_timeout=None, history_timeout=None, bars_timeout=None, ping_interval=None, no_message_timeout=None, auto_reconnect=False, reconnect_backoff=None, reconnect_max_backoff=None, reconnect_max_attempts=None, proxy=None, certificate=None, certificate_password=None, common_key=None, placed_type=None, all_order_updates=False)
+```
+
+A connection to one MetaTrader 5 account through the licensed core.
+
+>>> with Client(login, password, host, port, api_key="wk_...") as c:
+...     print(c.quote("EURUSD"))
+
+Credentials and library: `api_key` falls back to the `WMTAPI_KEY` environment variable and `token_url` to
+`WMTAPI_TOKEN_URL` (the core reads both itself); `dll_path` falls back to `WMTAPI_DLL`, then to the core
+bundled in the wheel.
+
+Timeouts are in seconds: `connect_timeout` (one connect attempt on one server), `cluster_member_timeout` (the
+per-server limit while failing over across the broker's cluster), `token_timeout` (each licence request), `execution_timeout` (a trade confirmation),
+`quote_timeout` (waiting for a quote), `history_timeout` / `bars_timeout` (downloads), `ping_interval`
+(keepalive), `no_message_timeout` (silence after which `connected` turns false). Every timeout must be
+positive; the quote, history and bars timeouts are the defaults of `quote`, `history` and `bars`.
+
+Reconnecting: `auto_reconnect=True` turns on the core's watchdog (exponential backoff with jitter, failover to the
+broker's cluster members, re-subscription); tune it with `reconnect_backoff` / `reconnect_max_backoff` (seconds)
+and `reconnect_max_attempts` (0 = until reconnected or `disconnect()`). Do not poll `connected` and call
+`connect()` in a loop.
+
+`proxy` routes the connection through a `Proxy`. `certificate` / `certificate_password` are for brokers
+that require a client certificate (the bytes of a `.pfx` file); `common_key` (15 bytes) is for servers that
+require one. `placed_type` records how orders are placed (`"manual"`
+or `"expert"`; a per-call `placed_type="manual"` equals the default and so takes the client's value). `all_order_updates=True` also delivers the intermediate order states to
+`on_order_update`.
+
+Callbacks run on the core's worker threads, not on the thread that created the client.
+
+## Connection and session
+
+#### `account_method` *(property)*
+
+`"Hedging"` or `"Netting"`.
+
+#### `async aconnect()`
+
+Awaitable `connect`; the blocking connect runs on a worker thread.
+
+#### `async adisconnect()`
+
+Awaitable `disconnect`.
+
+#### `base_info()`
+
+The server's own description of itself and of the account mode.
+
+#### `can_trade` *(property)*
+
+This login may place trades: not investor, not disabled on the server, confirmed.
+
+#### `change_password(new_password, investor=False)`
+
+Change the account password; with `investor=True` the read-only investor password instead of the main
+one. The new password applies from the next connection.
+
+#### `company` *(property)*
+
+The broker's company name, as the server reports it.
+
+#### `connect()`
+
+Connect, authorise through the licence service and load the account. Returns `self`. Calling it on a
+client that is already connected does nothing (it never opens a second session).
+
+#### `connect_time` *(property)*
+
+When this session connected, by the local clock.
+
+#### `connected` *(property)*
+
+Live: false when the socket died or the server has been silent past `no_message_timeout`.
+
+#### `core_version` *(property)*
+
+The version of the licensed core library in use.
+
+#### `disconnect()`
+
+Close the session and stop the core's reconnect watchdog for good — also when the link is down and the
+watchdog is mid-way through reconnecting. Harmless when never connected.
+
+#### `host` *(property)*
+
+The access server this client was created for (it may fail over to a cluster member).
+
+#### `is_confirmed` *(property)*
+
+False while the broker has not yet confirmed the account (trading is blocked until it is).
+
+#### `is_investor` *(property)*
+
+The login is the read-only investor password.
+
+#### `last_quote_time` *(property)*
+
+The server timestamp of the last quote received (server time, not the local clock): compare it with
+`server_time`, not with `datetime.now()`.
+
+#### `last_server_message_time` *(property)*
+
+When the server last sent anything, by the local clock: a liveness signal.
+
+#### `login` *(property)*
+
+The account login number.
+
+#### `port` *(property)*
+
+The access-server port.
+
+#### `raw` *(property)*
+
+The underlying core object, for anything this layer does not wrap. Calls made on it raise the core's own
+exceptions, not pmt5api's.
+
+#### `server_time` *(property)*
+
+The server's clock, kept current by incoming quotes (server time, naive); `None` before the first
+connect.
+
+#### `server_utc_offset` *(property)*
+
+The server's offset from UTC; `None` before the first connect.
+
+#### `symbol_build` *(property)*
+
+The server's symbol-database build number.
+
+#### `trade_build` *(property)*
+
+The server's trade build number.
+
+#### `trading_disabled_by_server` *(property)*
+
+Trading is disabled for this account on the server side.
+
+## Symbols, quotes and bars
+
+#### `async aquote(symbol, timeout=None)`
+
+Awaitable `quote` (runs on a worker thread; never blocks the event loop).
+
+#### `bars(symbol, timeframe='H1', *, count=None, start=None, end=None, timeout=None)`
+
+OHLC bars, oldest first, in the broker's server time.
+
+Give `count` for the latest N bars, or `start` (and optionally `end`) for a window; with neither, the
+latest 500. `timeframe` is a name — `M1 M2 M3 M4 M5 M6 M10 M12 M15 M20 M30 H1 H2 H3 H4 H6 H8 H12 D1 W1 MN1` —
+or its length in minutes. Higher timeframes are built from the server's one-minute bars with the tick volume
+summed; minutes after `end` are not used (no look-ahead); the last bar may still be forming.
+`timeout` (seconds, default: the client's `bars_timeout`) bounds the whole call.
+
+#### `commission(symbol)`
+
+The commission schedule that applies to a symbol, or `None` when the broker defines none.
+
+#### `contract_size(symbol)`
+
+The contract size of a symbol (units of the instrument per 1.0 lot).
+
+#### `find_symbol(prefix)`
+
+The symbol `prefix` names: the exact name if the broker has it, else the only symbol that starts with
+it. `None` when there is none; an `InvalidRequestError` listing the candidates when several do
+(use `find_symbols` and choose).
+
+#### `find_symbols(prefix)`
+
+Every symbol whose name starts with `prefix` (brokers add suffixes such as `m` or `.s`), exact
+match first, then shortest name.
+
+#### `has_symbol(name)`
+
+Whether the broker offers `name` exactly as spelled.
+
+#### `is_quote_session(symbol)`
+
+The symbol is inside one of its quote sessions right now (server clock).
+
+#### `is_subscribed(symbol)`
+
+Whether the live feed of `symbol` is on.
+
+#### `is_trade_session(symbol)`
+
+The symbol is inside one of its trade sessions right now (server clock).
+
+#### `ledger_value_per_lot(symbol)`
+
+What the account's own closed deals say one price unit on one lot is worth for this symbol, or `None`
+when the account has not closed enough deals on it.
+
+#### `quote(symbol, timeout=None)`
+
+The current quote of one symbol, waiting up to `timeout` seconds (default: the client's `quote_timeout`)
+for the first tick; `NoQuoteError` if none arrives.
+
+#### `request_bars(symbol, day=None)`
+
+Ask the server for one-minute bars without waiting; the answer arrives through `on_quote_history`.
+With no `day` this is today's bars, otherwise the block ending at `day`.
+
+#### `sessions(symbol)`
+
+When a symbol is quoted and traded, per weekday (0 = Sunday), in minutes from 00:00 server time.
+
+#### `subscribe(*symbols)`
+
+Start the live quote feed for the given symbols (names, or lists of names).
+
+#### `subscriptions()`
+
+The symbols currently subscribed.
+
+#### `symbol(name)`
+
+One symbol's specification and trading rules.
+
+#### `symbol_groups()`
+
+The names of the broker's symbol groups.
+
+#### `symbols()`
+
+Every symbol the broker offers on this account, by name, with its trading rules.
+
+#### `tick_value(symbol, side='ask', timeout=None)`
+
+The value, in account currency, of one full price unit per 1.0 lot (as the terminal computes it).
+
+This is an *input* to position sizing, not a recipe: see `lots_for_risk`. `side` is `"ask"` (what a
+long position is priced against) or `"bid"`. Waits up to `timeout` seconds (default: `quote_timeout`)
+for a live quote. Raises `InvalidRequestError` when the value cannot be computed (a symbol whose
+profit currency has no conversion rate), never a NaN.
+
+#### `unsubscribe(*symbols)`
+
+Stop the live quote feed for the given symbols (names, or lists of names).
+
+## Account, orders and history
+
+#### `account(refresh=True)`
+
+Account details. With `refresh` (the default) the equity, profit and margin figures are brought up to date
+first: every open position's symbol is quoted once and the profits are recalculated.
+
+#### `closed_orders()`
+
+The orders this session has seen close (a rolling cache of about ten). For anything older use
+`history`.
+
+#### `deal_history(year, month)`
+
+One calendar month of history (a convenience over `history`).
+
+#### `equity_history(start, timeframe='D1', exclude_same_bars=True)`
+
+The balance and equity curve since `start` (`timeframe` is `H1`, `H4` or `D1`).
+
+`balance` is exact; the historical `equity` is a bar-priced reconstruction and a point with
+`incomplete` set has understated floating P/L. With `exclude_same_bars` (the default, as in the C# library)
+consecutive points with an unchanged balance and equity are dropped. Downloads deals and per-symbol bars, so it
+blocks.
+
+#### `history(start=None, end=None, timeout=None)`
+
+Orders and deals between `start` and `end` (default: the last 30 days up to now). Blocks until the
+server has sent everything, up to `timeout` seconds (default: the client's `history_timeout`).
+
+Naive datetimes are used exactly as given, in the broker's server time; timezone-aware ones are converted to
+it. The default window is computed on the server's clock.
+
+#### `orders()`
+
+Everything currently working: open positions and pending orders.
+
+#### `positions()`
+
+Open positions only (pending orders excluded).
+
+A position is an order of type `Buy` or `Sell`; pending orders are the `*Limit` and `*Stop` types. The
+order's `state` is not used: the core can leave a freshly opened position in `Started` for a long time.
+
+#### `request_history(start, end)`
+
+Ask for history without waiting; it arrives through `on_history`. The server's answer is not trimmed
+to `start` / `end` (it can hold more than you asked for, in pages): filter by time. The blocking
+`history` does trim.
+
+#### `request_history_month(year, month)`
+
+Ask for one calendar month of history without waiting; it arrives through `on_history`.
+
+#### `summary(start=None, end=None)`
+
+Realized trading result, deposits and withdrawals, from the deal ledger (all time by default).
+
+Downloads the deal history, so it blocks; call it off your UI thread (or use `asyncio.to_thread`).
+
+#### `update_profits()`
+
+Recompute floating P/L and used margin from the current quotes. Warm the open positions' quotes first (or
+use `account(refresh=True)`, which does both).
+
+## Sizing and risk
+
+#### `calibrate_money_scale(start, *, min_deals_per_symbol=None, max_self_scatter=None, max_disagreement=None, max_snap_distance=None)`
+
+Measure what a price unit is worth *on this account* from its own closed deals since `start`.
+
+Read-only; places no order. Cent handling is a per-broker configuration, not a property of the currency, so
+sizing is refused until this has succeeded. Returns `False` when the scale cannot be established (read
+`money_scale_evidence`); more history usually fixes it.
+
+#### `lots_for_risk(symbol, entry_price, stop_price, risk_amount, *, lot_step=None, min_lot=None, max_ratio=None, max_equity_share=None, max_lot=None)`
+
+The volume that loses `risk_amount` (account currency) if `stop_price` is hit, with the evidence.
+
+Requires a successful `calibrate_money_scale`; without it the answer is a refusal. The volume is
+rounded **down**. Check `ok`: when false, `lots` is 0 and `reason` says which check failed.
+
+#### `money_scale` *(property)*
+
+The measured scale (`None` until `calibrate_money_scale` has succeeded).
+
+#### `money_scale_evidence` *(property)*
+
+Why the scale is what it is, or why it could not be established.
+
+#### `money_scale_from_deal(deal)`
+
+Re-measure the scale from ONE closed deal — the broker's own accounting of a trade that happened. Compare
+it with `money_scale`; a disagreement means every size derived from the calibration was wrong.
+
+#### `order_profit(symbol, open_price, close_price, lots, buy=True)`
+
+The P/L, in account currency, of `lots` moving from `open_price` to `close_price` (cent accounts
+included). For reporting a completed or hypothetical move; use `lots_for_risk` to size.
+
+#### `required_margin(symbol, lots, side='buy', price=0.0)`
+
+The margin needed to open `lots` of `symbol`, computed as the terminal does (`price` 0 = live quote).
+A reference figure, not a sizing input.
+
+## Order entry
+
+#### `async abuy(*args, **kwargs)`
+
+Awaitable `buy`.
+
+#### `async acancel(*args, **kwargs)`
+
+Awaitable `cancel`.
+
+#### `async aclose(*args, **kwargs)`
+
+Awaitable `close`.
+
+#### `async amodify(*args, **kwargs)`
+
+Awaitable `modify`.
+
+#### `async aplace_order(*args, **kwargs)`
+
+Awaitable `place_order`.
+
+#### `async asell(*args, **kwargs)`
+
+Awaitable `sell`.
+
+#### `buy(symbol, lots, *, sl=0.0, tp=0.0, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Buy at market (the current ask). `sl` / `tp` are prices (0 = none); `deviation` is the allowed
+slippage in points; `magic` is your own number, readable back on `Order` and `Deal`;
+`fill_policy` is `fok`, `ioc`, `flash` or `any`.
+
+#### `buy_async(symbol, lots, *, request_id=None, sl=0.0, tp=0.0, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Send a market buy and return with its request id as soon as the request is on the wire; the outcome arrives
+through `on_order_progress` (and `on_order_update`).
+
+A market order needs a price: if the symbol has no quote yet this first waits (up to the client's
+`quote_timeout`) for one, and raises `NoQuoteError` — nothing sent — if none arrives.
+
+#### `cancel(ticket, *, fill_policy=None, comment=None, placed_type=None)`
+
+Delete a pending order.
+
+#### `cancel_async(ticket, *, request_id=None, fill_policy=None, comment=None, placed_type=None)`
+
+Delete a pending order and return at once with its request id; see `cancel`.
+
+#### `close(ticket, lots=None, *, deviation=0, comment=None, fill_policy=None, close_by=None, placed_type=None)`
+
+Close a position at market, completely or (with `lots`) in part. `close_by` closes it against an
+opposite position of the same symbol (hedging accounts).
+
+#### `close_async(ticket, lots=None, *, request_id=None, deviation=0, comment=None, fill_policy=None, close_by=None, placed_type=None)`
+
+Close a position (or part of it) at market and return at once with its request id; see `close`.
+
+#### `modify(ticket, *, sl=None, tp=None, price=None, stop_limit=None, expiration=None, comment=None)`
+
+Change a position's stop-loss / take-profit, or a pending order's price / stops / expiration. Anything
+left as `None` keeps its current value.
+
+#### `modify_async(ticket, *, request_id=None, sl=None, tp=None, price=None, stop_limit=None, expiration=None, comment=None)`
+
+Modify a position or pending order and return at once with its request id; see `modify`.
+
+#### `new_request_id()`
+
+A unique id for an asynchronous trade call (the `*_async` methods take one for you).
+
+#### `place_order(symbol, kind, lots, price, *, sl=0.0, tp=0.0, stop_limit=0.0, expiration=None, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Place a pending order. `kind` is one of `buy_limit sell_limit buy_stop sell_stop buy_stop_limit
+sell_stop_limit` (the two stop-limit kinds also need `stop_limit`, the limit price). `expiration` is
+`None` (the broker's default), `"gtc"`, `"today"`, a `datetime` (that moment) or a `date` (that day).
+
+#### `place_order_async(symbol, kind, lots, price, *, request_id=None, sl=0.0, tp=0.0, stop_limit=0.0, expiration=None, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Place a pending order and return at once with its request id; see `place_order` and `buy_async`.
+
+#### `sell(symbol, lots, *, sl=0.0, tp=0.0, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Sell at market (the current bid).
+
+#### `sell_async(symbol, lots, *, request_id=None, sl=0.0, tp=0.0, deviation=0, comment=None, magic=0, fill_policy=None, trade_type=None, placed_type=None)`
+
+Send a market sell and return at once with its request id; see `buy_async`.
+
+## Events and streams
+
+#### `aorder_updates(*, maxsize=1000)`
+
+Async version of `order_updates`.
+
+#### `aquotes(*symbols, maxsize=10000)`
+
+Async version of `quotes` (no timeout; `aclose()` or cancel the task to stop). Call it inside a
+running event loop.
+
+#### `events_dropped` *(property)*
+
+How many events were dropped because callbacks fell too far behind (see the module notes).
+
+#### `on_connect_progress(callback)`
+
+Call `callback(event)` for each connect step and for a drop. This is how to tell a permanent failure from
+a transient one while `auto_reconnect` is on.
+
+#### `on_history(callback)`
+
+Call `callback(history)` when history requested with `request_history` arrives. The server may
+deliver it in pages (`history.more` says another page follows) and does not trim it to the range you asked
+for: filter by time.
+
+#### `on_order_progress(callback)`
+
+Call `callback(progress)` as an asynchronous trade request advances (see `buy_async`).
+
+#### `on_order_update(callback)`
+
+Call `callback(update)` when the server pushes a change to an order or position (opened, filled,
+modified, closed, stopped out ...). Set `all_order_updates=True` on the client to also receive the
+intermediate Started / Filled / Cancelling states.
+
+#### `on_quote(callback)`
+
+Call `callback(quote)` for every tick of every subscribed symbol. Returns a function that removes it.
+
+#### `on_quote_history(callback)`
+
+Call `callback(event)` when bars requested with `request_bars` arrive.
+
+#### `on_symbol_update(callback)`
+
+Call `callback()` when one symbol's data is (re)received; read `symbols` again.
+
+#### `on_symbols_update(callback)`
+
+Call `callback()` when the server pushes a change to the symbol list; read `symbols` again.
+
+#### `order_updates(*, timeout=None, maxsize=1000)`
+
+Iterate order updates (attached when called). Ends when `timeout` seconds pass without one.
+
+#### `quotes(*symbols, timeout=None, maxsize=10000)`
+
+Iterate live quotes of `symbols` (subscribing them first; with none given, every subscribed symbol).
+Ends when `timeout` seconds pass without a tick. The feed is attached when this is called, not at the first
+`next()`. If the consumer falls behind by more than `maxsize` quotes the oldest are dropped.
+
+## Module functions
+
+#### `load_servers_dat(source)`
+
+The trade servers in a terminal's `servers.dat`: each with its name, company and (host, port) access points.
+Offline: reads only the file (a path, or the file's bytes).
+
+#### `save_servers_dat(records)`
+
+The bytes of a `servers.dat` file holding `records` (the inverse of `load_servers_dat`).
+
+#### `request_demo_account(request, host, port=443)`
+
+Ask a broker's access server for a new demo account and return its login and passwords.
+
+This creates a real account at the broker: use it deliberately.
+
+#### `tick_value_from_deal(closed_profit, open_price, close_price, lots)`
+
+The value of one price unit per lot implied by a closed deal's realized P/L — the empirical check of a
+tick value.
+
+#### `enable_core_logging(logger_name='pmt5api.core')`
+
+Forward the core's log messages (`Logger.OnMsgEx`) and internal diagnostics (`Diag.Sink`) to the Python
+logger `logger_name`. Returns a function that switches it off again. Nothing is forwarded unless this is called,
+and the core is silent by default.
+
+#### `aggregate(minute_bars, minutes)`
+
+Build `minutes`-long bars from one-minute bars (any order; a repeated minute keeps its last value).
+
+#### `to_frame(items)`
+
+A `pandas.DataFrame` from a list of the package's value objects (`Bar`, `Order`, `Quote`, ...).
+
+A list of bars is indexed by its `time`; anything else keeps a plain integer index.
+
+## Data types
+
+#### `Quote`
+
+Quote(symbol: 'str', bid: 'float', ask: 'float', time: 'Optional[datetime]', last: 'float', volume: 'int')
+
+Fields: `symbol`, `bid`, `ask`, `time`, `last`, `volume`
+
+#### `SymbolInfo`
+
+A symbol's specification and trading rules.
+
+Fields: `name`, `description`, `digits`, `point`, `spread`, `contract_size`, `profit_currency`, `margin_currency`, `isin`, `custom`, `depth_of_market`, `calc_mode`, `gtc_mode`, `settlement_price`, `lower_limit`, `upper_limit`, `face_value`, `accrued_interest`, `raw_tick_value`, `raw_tick_size`, `group`, `trade_mode`, `execution`, `min_lots`, `max_lots`, `lots_step`, `min_stop_distance`, `min_take_distance`, `swap_type`, `swap_long`, `swap_short`, `triple_swap_day`, `initial_margin`, `maintenance_margin`
+
+#### `TradingSession`
+
+One trading or quoting window of a weekday, in minutes from 00:00 server time (`end` may be 1440).
+
+Fields: `start`, `end`
+
+#### `SymbolSessions`
+
+Per weekday (index 0 = Sunday … 6 = Saturday), the windows in which a symbol is quoted and traded.
+
+Fields: `symbol`, `quotes`, `trades`
+
+#### `CommissionInfo`
+
+CommissionInfo(group_name: 'str', type: 'str', period: 'str', money_currency: 'str', instant_type: 'str', tiers: 'Tuple[CommissionTier, ...]')
+
+Fields: `group_name`, `type`, `period`, `money_currency`, `instant_type`, `tiers`
+
+#### `BaseInfo`
+
+What the server says about itself: the broker, the account currency and its digits, the account mode.
+
+Fields: `company`, `currency`, `digits`, `account_method`, `margin_mode`
+
+#### `AccountInfo`
+
+AccountInfo(login: 'int', name: 'str', currency: 'str', leverage: 'int', balance: 'float', credit: 'float', equity: 'float', profit: 'float', margin: 'float', free_margin: 'float', margin_level: 'float', floating_pl: 'float' = 0.0, swap: 'float' = 0.0, commission: 'float' = 0.0, fee: 'float' = 0.0, blocked: 'float' = 0.0, company: 'str' = '', method: 'str' = '', account_type: 'str' = '', trade_flags: 'int' = 0, country: 'str' = '', city: 'str' = '', state: 'str' = '', zip_code: 'str' = '', address: 'str' = '', phone: 'str' = '', email: 'str' = '')
+
+Fields: `login`, `name`, `currency`, `leverage`, `balance`, `credit`, `equity`, `profit`, `margin`, `free_margin`, `margin_level`, `floating_pl`, `swap`, `commission`, `fee`, `blocked`, `company`, `method`, `account_type`, `trade_flags`, `country`, `city`, `state`, `zip_code`, `address`, `phone`, `email`
+
+#### `AccountSummary`
+
+Realized figures from the deal ledger: trading result apart from deposits and withdrawals.
+
+Fields: `balance`, `credit`, `realized_profit`, `deposit`, `withdrawal`
+
+#### `EquityPoint`
+
+One point of the balance/equity curve. `balance` and `balance_change` are exact (the deal ledger); the
+historical `equity` and `unrealized_pl` are a bar-priced reconstruction. `incomplete` is set when a symbol's
+bars did not arrive in time, so the floating part of that point is understated.
+
+Fields: `time`, `balance`, `equity`, `balance_drawdown_raw`, `balance_drawdown_relative`, `equity_drawdown_raw`, `equity_drawdown_relative`, `realized_pl`, `unrealized_pl`, `incomplete`, `balance_change`
+
+#### `LotSizing`
+
+The answer of `Client.lots_for_risk`. If `ok` is false, `lots` is 0 and `reason` says why:
+do not trade it. `warnings` can accompany a true `ok` (for example, nothing corroborated the scale).
+
+Fields: `ok`, `lots`, `expected_loss_at_stop`, `risk_requested`, `minimum_trade_cost`, `ratio`, `reason`, `warnings`
+
+#### `Order`
+
+An open position, a pending order, or a historical order.
+
+Fields: `ticket`, `symbol`, `order_type`, `deal_type`, `state`, `lots`, `digits`, `open_price`, `open_time`, `close_price`, `close_time`, `stop_loss`, `take_profit`, `profit`, `swap`, `commission`, `fee`, `comment`, `magic`, `close_lots`, `close_comment`, `contract_size`, `placed_type`, `request_id`, `stop_limit_price`, `profit_rate`, `expiration_type`, `expiration_time`, `fill_policy`
+
+#### `Deal`
+
+One executed deal from the account's ledger (a trade fill, or a balance operation such as a deposit).
+
+Fields: `ticket`, `order_ticket`, `position_ticket`, `symbol`, `type`, `direction`, `time`, `price`, `open_price`, `stop_loss`, `take_profit`, `lots`, `profit`, `commission`, `swap`, `contract_size`, `digits`, `comment`, `magic`
+
+#### `History`
+
+Result of a history download: the orders and the deals in the requested window.
+
+Fields: `orders`, `deals`, `action`
+
+#### `Bar`
+
+Bar(time: 'datetime', open: 'float', high: 'float', low: 'float', close: 'float', tick_volume: 'int', volume: 'int', spread: 'Optional[int]' = None)
+
+Fields: `time`, `open`, `high`, `low`, `close`, `tick_volume`, `volume`, `spread`
+
+#### `OrderUpdate`
+
+A change the server pushed about an order or a position. `type` is one of Started, Filled, PendingOpen,
+PendingModify, PendingClose, MarketOpen, MarketModify, MarketClose, PartialClose, MarketCloseBy, OnStopLoss,
+OnTakeProfit, OnStopOut, Balance, Expired, Rejected, Cancelling, Unknown.
+
+Fields: `type`, `order`, `ticket`, `transaction_id`, `close_by_ticket`
+
+#### `OrderProgress`
+
+Progress of an asynchronous trade request (the request id you got back from `*_async`).
+
+Fields: `request_id`, `status`, `ticket`, `position_id`, `volume`, `price`, `bid`, `ask`, `comment`, `order_type`, `symbol`, `fill_policy`
+
+#### `ConnectEvent`
+
+A step of the connect sequence: SendLogin, SendAccountPassword, AcceptAuthorized, RequestTradeInfo, Connected,
+Exception, Disconnect. `error` is the translated exception for `Exception` steps.
+
+Fields: `stage`, `error`
+
+#### `QuoteHistoryEvent`
+
+One-minute bars the server delivered after `Client.request_bars`.
+
+Fields: `symbol`, `bars`
+
+#### `ServerRecord`
+
+A trade server of a `servers.dat` file: its name, company and (host, port) access points.
+
+Fields: `name`, `company`, `access`
+
+#### `DemoAccountRequest`
+
+What `pmt5api.request_demo_account` asks a broker's server for.
+
+Fields: `user_name`, `email`, `deposit`, `leverage`, `account_type`, `country`, `city`, `state`, `zip_code`, `address`, `phone`, `company_name`, `language_id`
+
+#### `DemoAccount`
+
+DemoAccount(login: 'int', password: 'str', investor_password: 'str')
+
+Fields: `login`, `password`, `investor_password`
+
+#### `Proxy`
+
+A proxy the core connects through. `kind` is `"https"`, `"socks4"` or `"socks5"`.
+
+Fields: `kind`, `host`, `port`, `user`, `password`
+
+## Errors
+
+```
+WmtError
+  BusyError
+  ConnectError
+  ConnectionLostError
+  CoreNotFoundError
+  InvalidRequestError
+  LicenseError
+  NoQuoteError
+  NotConnectedError
+  ProxyError
+  RequestTimeout
+  RuntimeNotFoundError
+  ServerError
+    InvestorModeError
+  TokenServiceError
+```
+
+- `BusyError` — The core allows one request of this kind at a time and one is still running; wait for it and retry.
+- `ConnectError` — The broker's access server could not be reached.
+- `ConnectionLostError` — An established connection was lost.
+- `CoreNotFoundError` — The licensed core library (wmt5api.dll) could not be located.
+- `InvalidRequestError` — The request was rejected before it was sent (for example, a symbol the server does not know).
+- `InvestorModeError` — The account was opened with an investor (read-only) password and the request needs trading rights.
+- `LicenseError` — The licence service refused the request. `reason` is one of: NoKey, Invalid, Expired, Revoked, RateLimited, LoginNotAllowed, AccountLimitReached, Unknown.
+- `NoQuoteError` — No quote was available in time to read or to trade against. Nothing was sent.
+- `NotConnectedError` — The call needs a connection and the client is not connected.
+- `ProxyError` — The configured proxy refused or failed.
+- `RequestTimeout` — The server did not answer within the requested time. For a trade call this means the request WAS sent and was not confirmed in time: the order may have been accepted; look at `orders()` before sending again. (When nothing was sent, `NoQuoteError` is raised instead.)
+- `RuntimeNotFoundError` — The .NET runtime needed to host the core could not be started.
+- `ServerError` — The broker's server refused the request (for example an incorrect login or password, or a rejected order). `code` is the server's return code by name (`"REQUOTE"`, `"NO_MONEY"`, `"INVALID_PRICE"`, ...) and `code_value` its number; both are `None` when the refusal carried no code.
+- `TokenServiceError` — The licence service could not be reached or answered with something unusable (not a licence decision).
+- `WmtError` — Base class of every pmt5api error.