API Reference

Complete API documentation for all public modules, classes, and methods.

---

Overview

The syntiq-mt5 API is organized into focused modules:

• Client

  ---

  Main entry point — MetaTrader5Client with all operations

• Account

  ---

  Account information models and services

• Positions

  ---

  Open position models and retrieval

• :material-candlestick: Market

  ---

  Candles, rates, and market data

• Orders

  ---

  Order placement, validation, and management

• History

  ---

  Historical orders and deals

• Symbols

  ---

  Symbol information and specifications

• Ticks

  ---

  Raw tick data retrieval

• Terminal

  ---

  Terminal state and configuration

• Market Book

  ---

  Level 2 order book data

• Connection

  ---

  Connection lifecycle and credentials

• Core

  ---

  Result[T], errors, and execution primitives

---

Usage Pattern

All API methods follow the same pattern:

from syntiq_mt5 import MetaTrader5Client

with MetaTrader5Client() as mt5:
    result = mt5.some_operation()

    if result.success:
        # Use result.data
        print(result.data)
    else:
        # Handle error
        print(f"Error {result.error_code}: {result.error_message}")

Every method returns Result[T] — never raises exceptions for operational failures.