MT5Account — Master Overview¶
One page to orient fast: what lives where, how to choose the right API, and jump links to every overview and method spec in this docs set.
🚦 Start here — Section Overviews¶
-
Account_Information — Overview Account balance/equity/margins, single‑value getters & summary.
-
Orders.Positions.History — Overview What’s open now, tickets, orders/deals history, positions history.
-
Symbols_and_Market — Overview Symbols inventory, properties, sessions, margin rates, market book (DOM).
-
Trading_Operations — Overview Place/modify/close orders, preflight checks, margin calculations.
-
Subscriptions_Streaming — Overview Live streams: ticks, trade deltas, transactions, P/L snapshots, IDs‑only.
🧭 How to pick an API¶
If you need… | Go to… | Typical calls |
---|---|---|
A single account metric | Account_Information | account_info_double/integer/string , account_summary |
Live objects or history | Orders.Positions.History | opened_orders , opened_orders_tickets , order_history , positions_history , positions_total |
Symbol specs & market plumbing | Symbols_and_Market | symbol_info_* , symbols_total , market_book_* |
Trading actions / feasibility | Trading_Operations | order_send/modify/close , order_check , order_calc_margin |
Realtime updates | Subscriptions_Streaming | on_symbol_tick , on_trade , on_trade_transaction , on_position_profit , on_positions_and_pending_orders_tickets |
🔌 Usage pattern (SDK wrappers)¶
Every method follows the same shape:
- Service/Method (gRPC):
Service.Method(Request) → Reply
- Low-level stub:
ServiceStub.Method(request, metadata, timeout)
- SDK wrapper (what you call):
await MT5Account.method_name(..., deadline=None, cancellation_event=None)
- Reply: SDK returns
.data
payload (already unwrapped) unless otherwise noted.
Timestamps = UTC (google.protobuf.Timestamp
). For long‑lived streams, pass a cancellation_event
.
📚 Full Index · All Method Specs¶
📄 Account Information¶
- Overview: Account_Information_Overview.md
- Single‑value getters – account_info_double.md – account_info_integer.md – account_info_string.md
- Summary – account_summary.md
📦 Orders · Positions · History¶
- Overview: OrdersPositionsHistory_Overview.md
- Live now – opened_orders.md – opened_orders_tickets.md – positions_total.md
- History – order_history.md – positions_history.md
🏷️ Symbols and Market¶
- Overview: SymbolsandMarket_Overview.md
Inventory¶
Properties & Quotes¶
- symbol_params_many.md
- symbol_info_double.md
- symbol_info_integer.md
- symbol_info_string.md
- symbol_info_tick.md
Sessions & Margin¶
- symbol_info_session_quote.md
- symbol_info_session_trade.md
- symbol_info_margin_rate.md
- Pricing utils: tick_value_with_size.md
Market Book (DOM)¶
🛠 Trading Operations¶
- Overview: TradingOperations_Overview.md
- Placement & lifecycle – order_send.md – order_modify.md – order_close.md
- Feasibility & costs – order_check.md – order_calc_margin.md
📡 Subscriptions · Streaming¶
- Overview: SubscriptionsStreaming_Overview.md
- Prices & symbols – on_symbol_tick.md
- Trading events – on_trade.md – on_trade_transaction.md
- P/L & IDs snapshots – on_position_profit.md – on_positions_and_pending_orders_tickets.md
“May your risk stay capped and your curiosity uncapped.”