Перейти к основному содержимому

АЛОР Брокер API

Торговая система АЛОР Брокер предоставляет пользователям возможности получения биржевой информации и управления торговыми заявками с помощью интерфейсов программного взаимодействия, более известных как интерфейсы программирования приложений (API).

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

Биржи​

С помощью API пользователь может взаимодействовать со следующими биржами:

  • Московская Биржа (MOEX)
  • Биржа СПБ (SPBX)
примечание

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

Типы данных​

В ответ на запрос торговая система может предоставить пользователю данные следующих типов:

  • Информация о всех сделках
  • Информация о всех заявках
  • Доступные финансовые инструменты
  • Котировки финансовых инструментов
  • Биржевые стаканы
  • Исторические данные
  • Позиции в портфеле
  • Информация о клиенте
примечание

Выполнение большинства запросов на получение информации требует авторизации от имени торгового аккаунта.

Типы заявок​

С помощью запросов к API торговой системы пользователь может управлять следующими типами заявок:

примечание

Выполнение всех запросов, связанных с заявками, требует авторизации от имени торгового аккаунта, к которому эти заявки относятся.

Контуры​

Для взаимодействия с API торговой системы доступны два контура эксплуатации: Тестовый и Боевой.

  • Тестовый контур — игровая среда системы, предназначенная для тестирования запросов к API и основанных на них приложений
  • Боевой контур — рабочая среда системы, предназначенная для взаимодействия с настоящими биржами

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

подсказка

Подробнее о контурах системы на странице Контуры системы

Протоколы соединения​

Для взаимодействия с торговой системой пользователь может использовать следующие интерфейсы API в зависимости от выбранного протокола соединения:

Помимо этого, для получения данных также можно использовать GraphQL API.

примечание

Предоставляемые интерфейсы поддерживают только защищённые версии используемых для соединения протоколов — https и wss.

Авторизация​

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

В зависимости от задач, стоящих перед пользователем, API торговой системы предлагает два способа авторизации:

  1. Авторизация с помощью JWT токена. Данный способ предназначен для авторизации запросов, выполняемых пользователем API от своего имени: персональные торговые роботы, ручная отправка запросов к интерфейсам и другие операции, выполняемые участником торгов непосредственным обращением к API системы.
  2. Авторизация по стандарту OAuth 2.0. Данный способ предназначен для облегчения разработчикам решения задачи авторизации операций в приложениях, с которыми будут работать сторонние пользователи от своего имени: публичные торговые терминалы и другие приложения, предоставляющие своим пользователям доступ к их торговым аккаунтам.
предупреждение

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

подсказка

Подробнее о способах авторизации и их особенностях в разделе Авторизация.

Что дальше?​

Чтобы начать работу с API, ознакомьтесь с руководствами по быстрому старту для боевого и тестового контуров, последовательно описывающими необходимые для выполнения запросов шаги.

Чтобы взаимодействие с системой было более эффективным, рекомендуем ознакомиться со следующими материалами:

Поддерживаемые системой запросы к HTTP API и WebSocket API и их особенности описаны в соответствующих разделах.

Используя предоставляемые системой ресурсы (задокументированные и нет), Вы принимаете действующие в момент выполнения запроса Правила платформы.