Инструкция по использованию API. Быстрый старт

С помощью нашего API вы можете создать собственную программу для торговли — например, торгового робота, который сам будет отслеживать рынок и реагировать на изменения быстрее человека. Вот несколько примеров, для чего это может пригодиться

💡 Обратите внимание
Чтобы торговать через API, у вас должен быть хотя бы один брокерский счет в БКС Мир инвестиций
Открыть счет

С чего начать

Войдите в веб-версию БКС Мир инвестиций. Откройте раздел «Профиль» и под заголовком «Счета и тарифы» нажмите на брокерский счет, к которому вы хотите получить доступ с помощью API.

Откроются настройки счета. Вам нужен пункт «Токены API».

В этом разделе вы можете выпустить токены. Чтобы начать выпуск, нажмите «Выпустить токен» и следуйте инструкциям.

Получив токен, скопируйте его и сохраните в надежном месте. Теперь можно переходить к авторизации.

Схема авторизации. Токены refresh и access

Токены, которые вы получаете через веб-версию, называются refresh-токены. Они бывают двух типов:
Для торговли и чтения данных
Только для чтения
Подробнее о правах доступа

С помощью полученного refresh-токена вы самостоятельно генерируете access-токен и авторизуетесь с его помощью. Запрос авторизационного токена описан в разделе Авторизация

Access-токен имеет срок жизни 24 часа, затем его необходимо получить заново.

Refresh-токен имеет срок жизни 90 суток. Также вы можете удалить его вручную через веб-версию БКС Мир инвестиций в разделе «Токены API», нажав на значок удаления справа от токена. Все access-токены, выпущенные с его использованием, станут недействительными.

💡 Важно
После удаления refresh-токена с правами «Только для чтения» access-токен, выпущенный с его использованием, продолжит работать до истечения его срока (не более 24 часов).
Access-токен для торговли удаляется мгновенно.

Права доступа

Refresh-токены, в свою очередь, делятся на два типа по правам доступа:
для торговли и чтения данных
только для чтения

Различия:

	Для торговли и чтения данных	Только для чтения
Создавать рыночные и лимитные заявки на заключение биржевых сделок на Мосбирже	✔	—
Анализировать цены на активы на Мосбирже	✔	✔
Получать данные о вашем портфеле — сумма и количество активов, доходность и др.	✔	✔
Тестировать торговые стратегии на исторических данных	✔	✔

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

Памятка: цикл жизни токенов

Токен выпускается бесплатно. Через 90 суток срок действия токена закончится, но вы всегда можете выпустить новый. Рекомендуем заранее поставить себе напоминание и за несколько дней до истечения срока выпустить новый токен
Каждый токен привязан только к одному брокерскому счету. Количество токенов, действующих одновременно, не ограничено.
Важно: сгенерированный токен не хранится в системе. Мы покажем вам токен только один раз — сразу после создания. Будьте готовы сохранить его в надежном месте
Вы можете в любой момент удалить токен через веб-версию БКС Мир инвестиций

Следующий шаг — авторизация

Подсказка для начинающих с нуля

Чтобы написать программу, использующую наш API, прежде всего выберите язык программирования, например Python, Java, Golang, Kotlin, C#.

Для работы с API вам нужно будет отправлять и принимать HTTP-запросы. Например, в Python это можно делать с помощью библиотеки requests.

Примерная логика программы будет такой:

Авторизоваться
1.1. Получить в веб-версии refresh-токен (инструкция)
1.2. Отправить HTTP-запрос для получения access-токена (см. Авторизация). Полученный access-токен будет использоваться для всех остальных действий
Отправить HTTP-запрос для получения информации о вашем портфеле (см. Лимиты).
Дальше можно изучить, как работает получение биржевой информации, подача торговых заявок и их редактирование – и при желании добавить эти возможности в вашу программу. Идеи можно почерпнуть в этой статье