Перейти к содержанию

Протокол взаимодействия с TINKOFF INVEST API

Вся работа с TINKOFF INVEST API происходит по протоколу gRPC, документацию которого можно найти по ссылке: https://grpc.io/docs/.

Одной из ключевых особенностей протокола следует назвать Bidirectional-stream — это особый режим работы, при котором открывается одно стрим-соединение, отправлять сообщения в которое могут оба участника взаимодействия. Это позволяет более гибко и оперативно реализовать работу. Например, bidirectional-stream сервиса котировок в одном и том же соединении принимает сообщения об изменении статуса подписки и предоставляет различные виды биржевой информации (стаканы, свечи, поток обезличенных сделок и т.д.). Подробнее о данном режиме работы можно ознакомиться в документации протокола.

Авторизация в TINKOFF INVEST API

Для успешной работы с TINKOFF INVEST API требуется передавать токен доступа в metadata каждого запроса.

Формат заголовка: Authorization: Bearer [токен доступа]

Например: Authorization: Bearer t.QtEo8ahkNFX4RTpbqp0u4z4GDZq27HzUp6AotJASBx7_DVqmqZMHfM2Cy7JmUjS80boI9eVg

Адреса сервиса TINKOFF INVEST API

Все вызовы продового сервиса выполняются по адресу invest-public-api.tinkoff.ru:443.

Все вызовы сервиса песочницы выполняются по адресу sandbox-invest-public-api.tinkoff.ru:443.

Различия работы контуров описаны на странице.

tracking-id запросов

Во все ответы unary-методов TINKOFF INVEST API добавляется заголовок x-tracking-id. Это уникальный uuid-идентификатор запроса, который необходим технической поддержке для разбора различных инцидентов. При обращении в службу технической поддержки обязательно указывайте tracking-id запроса, это ускорит решение вашего вопроса.

Для сообщений управления статусом подписки в рамках stream-соединений tracking-id передаётся явно в виде выходного параметра.

Полный текст ошибки

В случае ошибки при исполнении методов в TINKOFF INVEST API ответа добавляется заголовок message. В данном заголовке приходит полный текст описания ошибки.

В Kreya вы можете посмотреть текст ошибки на вкладке Header, в поле message.

Appname запросов

TINKOFF INVEST API позволяет в запросах добавлять служебный заголовок x-app-name, который нужен для сбора статистики по используемым инструментам. Если вы разработчик SDK, рекомендуется использовать app-name формата <Ник в GitHub>.<Название репозитория>. Например, user.tinkoffSDK.

Рекомендации по тестированию методов TINKOFF INVEST API

Для тестирования работы TINKOFF INVEST API можно использовать любой доступный grpc-клиент. Ниже приведены краткие инструкции по настройке двух наиболее популярных из них.

Kreya

Данный бесплатный gRPC-клиент предоставляет довольно широкий набор функциональности и возможностей. Скачать его можно с официального сайта kreya.app.

  1. После установки и запуска приложения перейдите в меню Project — Importers. Интерфейс Kreya
  2. Нажмите New importer. Укажите название источника данных и его тип (gRPC proto files). Интерфейс Kreya
  3. Нажмите Add proto directory и укажите папку со скаченными proto-контрактами сервиса TINKOFF INVEST API. Скачать актуальную версию контрактов можно по ссылке: TINKOFF INVEST API. Интерфейс Kreya
  4. Сохраните изменения и нажмите Back.
  5. В левом окне нажмите на появившуюся папку Tinkoff. Укажите Endpoint сервиса: https://invest-public-api.tinkoff.ru:443. Остальные настройки укажите в соответствии со скриншотом. Обратите внимание на блок Metadata, в нём требуется указать заголовок Authorization, в значении которого передаётся строка "Bearer <токен доступа>". Подробнее о том, как получить токен можно узнать по ссылке: Токен доступа Интерфейс Kreya
  6. Теперь вы можете выполнять запросы к сервису. Интерфейс Kreya

Kreya позволяет увидеть служебные заголовки ответа сервера: Интерфейс Kreya

  • x-ratelimit-limit — показывает настройки текущего лимита пользователя по данному методу.

  • x-ratelimit-remaining — количество оставшихся запросов данного типа в минуту.

  • x-ratelimit-reset — время в секундах до обнуления счётчика запросов.

BloomRPC

Скачать данный клиент можно по ссылке: bloomrpc releases.

Интерфейс утилиты достаточно прост, для старта работы требуется указать домен сервиса и импортировать все proto-файлы.

  1. Импортируйте скаченные proto-контракты сервиса. Интерфейс BloomRPC
  2. Укажите адрес сервера invest-public-api.tinkoff.ru:443 и заполните поле metadata значением (подставьте своё значение токена доступа).

{ "Authorization": "Bearer t.QtEo8ahkNFX4RTpbqp0u4z4GDZq27HzUp6AotJASBx7_DVqmqZMHfM2Cy7JmUjS80boI9eVg" } Интерфейс BloomRPC 3. При выполнении запросов следует обязательно указывать тип TLS-подключения: Интерфейс BloomRPC 4. Теперь вы можете выполнять запросы к сервису. Интерфейс BloomRPC

BloomRPC не позволяет увидеть заголовки ответа сервера, поэтому команда TINKOFF INVEST API рекомендует использовать Kreya.