1.0.0AsyncAPI 3.0.0

Finam Trade API (WebSocket)

WebSocket подписки на котировки/сделки/стакан/свечи/заявки. Клиент шлёт запросы (subscribe/unsubscribe/unsubscribe_all) в виде JSON, сервер отвечает envelope-ами: - DATA — payload с данными для разных подписок (варианты для BARS, ORDER_BOOK, QUOTES, TRADES, ORDERS) - ERROR — ошибка (валидация, аутентификация,недоступность upstream и т.п.) - EVENT — служебные события (HANDSHAKE_SUCCESS, CONNECTION_CLOSED и т.п.)

wss
api.finam.ru:443

Production WebSocket host

API Key

AuthorizationHeader

JWT напрямую передается в Authorization HTTP header. Пример - Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

header
SASL plain

TokenInPayload

JWT передаётся в теле сообщения на подписку. См. пример `SubscribeBars`

PUB

Клиент отправляет команды SUBSCRIBE/UNSUBSCRIBE/UNSUBSCRIBE_ALL

/ws

WsRequest

  • action

    enum

    required

    Действие

  • type

    enum

    Тип подписки

  • data

    object

    Данные запроса. Структура зависит от типа подписки. Подробнее в examples

  • token

    string

    required

    Валидный JWT

SUB

Клиент получает информацию в рамках своих подписок, а также служебные события и ошибки

/ws

WsEnvelope

  • type

    enum

    required

    Тип сообщения

  • subscription_key

    string

    Опциональный идентификатор подписки (если применяется)

  • subscription_type

    enum

    Тип подписки

  • timestamp

    integer

    required

    Метка времени в формате unix timestamp

  • payload

    oneOf

    Полезная нагрузка (тип зависит от subscriptionType)

  • error_info

    object

  • event_info

    object