Если вы ищете документацию по MetaTrader API, самое сложное — это не читать документацию. Речь идет о том, чтобы выяснить, какой интерфейс документа действительно соответствует вашему рабочему процессу. Официальная документация по языку MT4, официальная документация MT5, официальная документация по интеграции Python и документация по веб-ориентированным услугам решают различные проблемы.

Прямой ответ: с чего начать

если тебе нужноДокументация по API MetaTraderсначала определите рабочий процесс, который вы хотите реализовать.

Самый быстрый способ выбрать нужный документ: ВоспользуйтесьMQL4-документацияПриходите узнать о языке MT4 и поведении терминала. использоватьMQL5-документацияУзнайте о языке MT5, торговых функциях и других официальных справочных материалах. использоватьОфициальная документация MT5 PythonУзнайте о рабочих процессах Python, связанных с терминалом. Используйте, когда вашему приложению требуется документированная, сервис-ориентированная панель мониторинга, предложение SaaS, вход в учетную запись, история учетной записи, отчетность или интерфейс мониторинга учетной записи.Собственная документация по веб-API

Это ключевой момент, который упускают из виду большинство поисковиков: не существует единого дерева документации, которое бы четко охватывало все рабочие процессы, связанные с MetaTrader. Правильный набор документации зависит от того, работает ли ваш код внутри платформы, рядом с терминалом или на границе веб-приложения.

Если вы еще не читали обзор категории, начните с «Что такое MetaTrader API?» В этой статье объясняется, почему ландшафт документации вообще фрагментирован.

Почему документация MetaTrader API кажется фрагментированной

Когда поисковая фраза указывает на несколько схем, документация может показаться фрагментированной. тот, кто ищетДокументация API МТ5Разработчикам может понадобиться Справочник по языку MQL5, официальная интеграция с Python или руководство по веб-ориентированному API для внешних приложений. Они связаны, но это не одна и та же граница.

Официальная документация делает это разделение очевидным:

  • Справочник MQL4 по языку MetaTrader 4 и функциям терминала
  • Справочник MQL5 по языку MetaTrader 5, функциям, событиям и сопутствующим официальным ссылкам
  • Интеграция MetaTrader 5 Python для рабочих процессов Python с терминальными подключениями
  • Документация MetaTraderAPI.dev для сторонних уровней обслуживания и рабочих процессов API, ориентированных на учетные записи.

В документации станет легче ориентироваться, как только вы перестанете ожидать, что дерево документов все объяснит.

Правильный путь к документу зависит от границы рабочего процесса: кода терминала, интеграции Python или логики веб-приложения.

Основной интерфейс документа

1. Документация MQL4

Пожалуйста, обращайтесь к Справочнику MQL4, когда вы используете языковые структуры, индикаторы, советники (советники) и торговые функции терминала MT4. Если ваша миссия напрямую связана с поведением MT4 на платформе, то это подходящее место для начала.

Это не лучшая отправная точка для понимания архитектуры сервисного уровня или дизайна внешних приложений. Его лучше всего использовать для понимания того, что предоставляет сам MT4 и как ведет себя логика терминала.

2. Документация MQL5

Справочник MQL5 — это официальная основа поведения языка MT5, обработки событий, торговых функций, концепций стандартной библиотеки и соответствующих официальных ссылок. Для многих разработчиков это наиболее широко документированный интерфейс в мире MetaTrader.

Если вы сравниваете возможности платформы, документация MQL5 также поможет объяснить, почему MT5 в целом кажется более мощной платформой для развития в долгосрочной перспективе. Это основная тема нашей статьи «Сравнение API MT4 и API MT5».

3. Официальная документация по интеграции MT5 Python.

Если рабочий процесс конкретно включает в себя вызов процессов терминала MetaTrader 5 через Python, вам подойдет Справочник по интеграции MetaTrader 5 Python.initialize() Страница особенно полезна, поскольку она поясняет фактическую модель подключения.

Это важно, поскольку многие пользователи ошибочно полагают, что эти документы описывают общий REST API для Интернета. Не так. Они описывают рабочий процесс Python, подключенный к терминалу.

4. Собственная документация по веб-API

Если вашему приложению требуется интерфейс интеграции на уровне приложения с Интернетом, одной официальной документации по языку терминала недостаточно. Здесь в игру вступает сторонняя сервисная документация. Введение в документацию MetaTraderAPI.dev ясно показывает эту разницу, а на странице аутентификации четко указано документированное разделение аутентификации: Использование плана для одной учетной записи x-api-key Плюс UUID учетной записи, в то время как план Professional использует базовую аутентификацию (Basic Auth) по выделенному базовому URL-адресу.

Дерево собственной документации намного шире, чем вводная страница. Он организован на основе семейства рабочих процессов для MT4 и MT5, включаяСчетСвязьИстория заказов (История заказов)УслугаТорговая статистикаТорговля, плюс сторона MT5История котировок (QuoteHistory). Это означает, что следующая страница зависит от задачи, которую вы реализуете, а не только от названия продукта в URL-адресе.

Например, в документе счета записано что-то вроде /RegisterAccount/GetAccountsи /AccountSummaryи т. д., а документация по подключению MT4 и документация по подключению MT5 /CheckConnect Используется для проверки состояния соединения. Другие собственные разделы охватывают исторические рабочие процессы, сервисные утилиты, отчеты и операции транзакций, поэтому командам следует ориентироваться по сериям рабочих процессов, а не читать документ как плоский список конечных точек.

Таблица наилучшей отправной точки интерфейса документа

  • Справочник MQL4: Язык MT4 и функции терминала -> Подходит для написания или понимания логики MT4 на стороне платформы.
  • Справочник MQL5: язык MT5, события, функции -> Подходит для разработки на MT5 или сравнения функций официальной платформы.
  • Интеграция MT5 с Python: Рабочий процесс Python для подключения терминала -> Подходит для взаимодействия Python с терминалом MetaTrader 5.
  • Собственная документация по веб-API: для запросов приложений, регистрации учетных записей, истории и транзакций -> подходит для создания информационных панелей, продуктов SaaS или рабочих процессов учетной записи на основе API.

С чего начинается рабочий процесс?

Если вы создаете бота или конечную стратегию

В зависимости от платформы начните с MQL4 или MQL5. Начните с чтения документации по языку и функциональности транзакций. Для многих разработчиков ботов этого достаточно на ранних стадиях.

Если вы создаете рабочий процесс исследований или автоматизации Python

Начните с официальной документации MT5 Python, затем проверьте, что обрабатывается в среде терминала, а что — на уровне вашего собственного приложения. Если рабочий процесс перерастет в продукт, позже вам также может понадобиться документация уровня обслуживания.

Если вы создаете информационную панель, клиентский портал или продукт SaaS

Начните со статей по категориям, например «Что такое MetaTrader API?», затем используйте официальную документацию, чтобы понять базовое поведение платформы, и, наконец, потратьте большую часть времени на реализацию сторонней документации по веб-API, которая описывает фактические границы сервиса.

Затем сузьте документы по семействам рабочих процессов. Если вы регистрируете учетную запись, начните с документации учетной записи. Если вы хотите проверить, является ли связанная учетная запись нормальной, начните с документа подключения. Если вам необходимо выполнить заказ, историю запросов или отчеты, перейдите на страницу истории заказов, статистики транзакций или транзакций, а не оставайтесь в обзорном материале.

Это путь, которому следует следовать большинству продуктовых команд, и он соответствует архитектурным проблемам, описанным в разделе «Создание FX SaaS с использованием MetaTrader API».

Если вы сначала оцените выбор платформы

Прежде чем углубляться в документацию, прочтите страницу сравнения. Неправильные решения о платформе могут привести к потере больше времени, чем поиск неправильных конечных точек. Вот почему статья «Сравнение API MT4 и API MT5» должна быть в первую очередь для многих команд.

Практический порядок чтения: начиная с понимания четких категорий и заканчивая выбором платформы и конкретными интерфейсами документов, которые соответствуют границам реализации.

Практические правила: Если в приложении есть пользователи, разрешения, информационные панели или автоматизация учетных записей, не ограничивайтесь только документацией по языку терминала. Быстро погрузитесь в служебный документ, определяющий фактические границы приложения, а затем сузьте его до семейства рабочих процессов, соответствующих текущей задаче.

Распространенные ошибки при чтении документации MetaTrader

Поиск по ключевому слову вместо рабочего процесса

буду искатьДокументация по API MetaTraderЭто нормально как шаг открытия. Но как план реализации это ужасно. Ваш рабочий процесс должен определять путь к документу.

Предполагая, что документация Python равна документации REST.

Не так. Официальная документация MT5 Python описывает интегрированную модель подключения терминалов, а не общий общедоступный веб-сервис.

С нетерпением ждем официальной документации, объясняющей каждую абстракцию, специфичную для продукта.

Официальная документация объясняет поведение официальной платформы. Если выбранный вами уровень интеграции добавляет идентификаторы учетных записей, ключи API, маршрутизацию служб или нормализацию платформы, вам необходимо просмотреть документацию стороннего продукта на предмет этой границы.

Не уменьшать масштаб до соответствующих разделов при работе с собственными документами.

Дерево документов будет более полезным, если вы на раннем этапе направите себя на правильную серию рабочих процессов. Команды тратят много времени, когда они застревают на вводной странице в поисках действий с учетной записью, истории, проверок обслуживания или рабочих процессов транзакций, задокументированных в соответствующих разделах.

Практический порядок чтения

  • Уточните категории.Прочтите базовые статьи, такие как «Что такое MetaTrader API?».
  • Выберите путь к платформе.Если применимо, сравните API MT4 и API MT5.
  • Прочтите официальную документацию, чтобы понять поведение базовой платформы.Используйте MQL4, MQL5 или официальную документацию MT5 Python.
  • Прочтите документацию стороннего сервиса, чтобы понять фактические границы приложения.Именно здесь методы аутентификации, идентификаторы учетных записей и конечные точки рабочих процессов становятся конкретными.
  • Ограничьтесь правильной серией рабочих процессов.В зависимости от задачи, которую вы выполняете, введите аутентификацию, учетную запись, соединение, историю заказов, услугу, статистику транзакций, историю котировок или страницу транзакций.
  • Сопоставьте документацию с архитектурой продукта.Определите, какие концепции принадлежат платформе, какие — вашему приложению, а какие — уровню служб интеграции.

Чтение документов становится намного проще, если вы перестанете требовать идеальный универсальный портал для документов и начнете спрашивать, какие границы должен объяснять каждый документ.

Оригинальное резюме: Разработчики обычно не увязают в отсутствии документации. У них возникли проблемы, потому что они прочитали неправильную документацию, чтобы понять границы того, что они на самом деле реализовали. Самые быстрые команды сначала рисуют рабочие процессы, а потом документируют пути.

в заключение

лучшийРуководство по документации MetaTrader APIФактически, это ориентир-пограничник.

Документация MQL4 объясняет язык MT4 и поведение терминала. В документации MQL5 объясняется язык MT5 и более широкий официальный интерфейс. В официальной документации Python объясняется рабочий процесс MT5 Python для подключения к терминалу. Собственная документация по веб-API объясняет границы служб, которые на самом деле вызывает ваше приложение, и становится очень полезной, если вы ориентируетесь по семейству рабочих процессов, а не по общим ключевым словам.

Как только вы адаптируете документацию к своему рабочему процессу, реализация станет проще.

Часто задаваемые вопросы (FAQ)

Если мне нужна документация по API MetaTrader, с чего мне начать?
отРабочий процессНачните с, а не с ключевых слов. использоватьMQL4-документацияИзучите язык MT4 и поведение терминала, используяMQL5-документацияЧтобы понять язык MT5 и справочник функций, используйтеОфициальная документация PythonПонимание рабочего процесса MT5 Python для терминальных подключений, используйте его, когда ваше приложение использует уровень API с веб-интерфейсом.Собственная сервисная документация

Является ли официальная документация Python для MetaTrader 5 такой же, как документация по REST API?
другой. чиновникДокументация MetaTrader 5 Pythonописывает пропускПроцесс терминала MetaTrader 5Рабочая интеграция с Python. Документация по REST или веб-ориентированному API описывает совершенно разные границы сервисов для использования приложениями, панелями мониторинга и уровнями автоматизации.

Почему документация по MetaTrader API кажется фрагментированной?
из-за терминологииMetaTrader APIОхвачено несколько различных режимов интеграции. Документация кажется фрагментированной только в том случае, если вам нужно дерево, объясняющее все рабочие процессы. Фактически, каждая область документации фокусируется на разных границах: язык MT4, язык MT5, интеграция Python или использование API уровня обслуживания.

Какие документы SaaS-командам следует прочитать в первую очередь?
SaaS-командаОбычно вам следует начать с руководства по категориям, затем использовать официальную документацию, чтобы понять поведение платформы, и, наконец, потратить большую часть времени на реализацию.Собственная сервисная документацияопределить фактический прикладно-ориентированный рабочий процесс.

Нужна ли мне как официальная документация, так и сторонняя документация по API?
Обычно да.Официальная документацияОбъясните язык и поведение платформы.Собственная документация по APIОбъясните, как выбранный вами уровень служб предоставляет доступ к учетным записям, соединениям и рабочим процессам приложений. Они отвечают на разные вопросы и наиболее полезны в сочетании.