|View as Markdown

Trade API

Токены и аутентификация в Finam Trade API

В системе используется двухэтапная схема аутентификации

  1. Получение ключа: Создайте секретный ключ в разделе «Токены» на портале Finam Trade API.
  2. Первичная авторизация: Вызовите метод Auth из сервиса AuthService, передав секретный ключ в тело запроса, чтобы получить первый JWT.
  3. Использование в запросах: Вставляйте полученный JWT в метаданные каждого запроса к OrdersService или MarketDataService и другие сервисы, в формате Authorization: Bearer <ваш_jwt_токен>.
  4. Автоматическое обновление (Рекомендуется):
    • Установите соединение с методом SubscribeJwtRenewal, сразу передав в него свой секретный ключ.
    • Сервер будет поддерживать открытый стрим и автоматически присылать новый JWT незадолго до истечения старого.
    • Ваше приложение должно подхватывать новый токен из стрима и использовать его для последующих запросов, что обеспечит бесперебойную работу без пауз
    • Или вызовите повторно метод Auth из сервиса AuthService
gRPC v2
api.finam.ru

production

API Key

jwt-token

metadata
|View as Markdown

UnaryПолучение JWT токена из API токена

/grpc.tradeapi.v1.auth.AuthService/Auth

Получение JWT токена из API токена Пример HTTP запроса: POST /v1/sessions Content-Type: application/json { "secret": "your-api-secret-key" } Все поля передаются в теле запроса

Request

  • secret

    string

    API токен (secret key)

Response

  • token

    string

    Полученный JWT-токен

|View as Markdown

UnaryПолучение информации о токене сессии

/grpc.tradeapi.v1.auth.AuthService/TokenDetails

Получение информации о токене сессии Пример HTTP запроса: POST /v1/sessions/details Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." } Токен передается в теле запроса для безопасности Получение информации о токене. Также включает список доступных счетов.

Request

  • token

    string

    JWT-токен

Response

  • created_at

    Timestamp

    Дата и время создания

  • expires_at

    Timestamp

    Дата и время экспирации

  • md_permissions

    MDPermission[]

    required

    Информация о доступе к рыночным данным

  • account_ids

    string[]

    required

    Идентификаторы аккаунтов

  • readonly

    bool

    Сессия и торговые счета в токене будут помечены readonly

|View as Markdown

Server StreamПодписка на обновление JWT токена. Стрим метод

/grpc.tradeapi.v1.auth.AuthService/SubscribeJwtRenewal

Подписка на обновление JWT токена. Стрим метод

Request

  • secret

    string

    API токен (secret key)

Response

  • token

    string

    Полученный JWT-токен

|View as Markdown

UnaryПолучение информации по конкретному аккаунту

/grpc.tradeapi.v1.accounts.AccountsService/GetAccount

Получение информации по конкретному аккаунту Пример HTTP запроса: GET /v1/accounts/A12345 Authorization: <token>

Request

  • account_id

    string

    Идентификатор аккаунта

Response

  • account_id

    string

    Идентификатор аккаунта

  • type

    string

    Тип аккаунта

  • status

    string

    Статус аккаунта

  • equity

    Decimal

    Доступные средства плюс стоимость открытых позиций

  • unrealized_profit

    Decimal

    Нереализованная прибыль

  • positions

    Position[]

    required

    Позиции. Открытые, плюс теоретические (по неисполненным активным заявкам)

  • cash

    Money[]

    required

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

  • portfolio_mc

    MC

    Общий тип для счетов Московской Биржи. Включает в себя как единые, так и моно счета.

  • portfolio_mct

    MCT

    Тип портфеля для счетов на американских рынках.

  • portfolio_forts

    FORTS

    Тип портфеля для торговли на срочном рынке Московской Биржи.

  • open_account_date

    Timestamp

    Дата открытия счета

  • first_trade_date

    Timestamp

    Дата первой торговой транзакции

  • first_non_trade_date

    Timestamp

    Дата первой неторговой транзакции

|View as Markdown

UnaryПолучение истории по сделкам аккаунта

/grpc.tradeapi.v1.accounts.AccountsService/Trades

Получение истории по сделкам аккаунта Пример HTTP запроса: GET /v1/accounts/A12345/trades?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z Authorization: <token> Параметры: - account_id - передается в URL пути - limit и interval - передаются как query-параметры

Request

  • account_id

    string

    Идентификатор аккаунта

  • limit

    int32

    Лимит количества сделок

  • interval

    Interval

    Начало и окончание запрашиваемого периода, Unix epoch time

Response

  • trades

    AccountTrade[]

    required

    Сделки по аккаунту

|View as Markdown

UnaryПолучение списка транзакций аккаунта

/grpc.tradeapi.v1.accounts.AccountsService/Transactions

Получение списка транзакций аккаунта Пример HTTP запроса: GET /v1/accounts/A12345/transactions?limit=50&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z Authorization: <token> Параметры: - account_id - передается в URL пути - limit и interval - передаются как query-параметры

Request

  • account_id

    string

    Идентификатор аккаунта

  • limit

    int32

    Лимит количества транзакций

  • interval

    Interval

    Начало и окончание запрашиваемого периода, Unix epoch time

Response

  • transactions

    Transaction[]

    required

    Транзакции по аккаунту

|View as Markdown

Server StreamПодписка на информацию по аккаунту. Стрим метод

/grpc.tradeapi.v1.accounts.AccountsService/SubscribeAccount

Подписка на информацию по аккаунту. Стрим метод

Request

  • account_id

    string

    Идентификатор аккаунта

Response

  • account_id

    string

    Идентификатор аккаунта

  • type

    string

    Тип аккаунта

  • status

    string

    Статус аккаунта

  • equity

    Decimal

    Доступные средства плюс стоимость открытых позиций

  • unrealized_profit

    Decimal

    Нереализованная прибыль

  • positions

    Position[]

    required

    Позиции. Открытые, плюс теоретические (по неисполненным активным заявкам)

  • cash

    Money[]

    required

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

  • portfolio_mc

    MC

    Общий тип для счетов Московской Биржи. Включает в себя как единые, так и моно счета.

  • portfolio_mct

    MCT

    Тип портфеля для счетов на американских рынках.

  • portfolio_forts

    FORTS

    Тип портфеля для торговли на срочном рынке Московской Биржи.

  • open_account_date

    Timestamp

    Дата открытия счета

  • first_trade_date

    Timestamp

    Дата первой торговой транзакции

  • first_non_trade_date

    Timestamp

    Дата первой неторговой транзакции

|View as Markdown

UnaryВыставление биржевой заявки

/grpc.tradeapi.v1.orders.OrdersService/PlaceOrder

Выставление биржевой заявки Пример HTTP запроса: POST /v1/accounts/A12345/orders Content-Type: application/json Authorization: <token> { "symbol": "SBER@MISX", "quantity": { "value": "10" }, "side": "SIDE_BUY", "type": "ORDER_TYPE_LIMIT", "time_in_force": "TIME_IN_FORCE_DAY", "limit_price": { "value": "150.50" } } Поле account_id берется из URL-пути, остальные поля передаются в теле запроса

Request

  • account_id

    string

    Идентификатор аккаунта

  • symbol

    string

    Символ инструмента

  • quantity

    Decimal

    Количество в шт.

  • side

    Side

    Сторона (long или short)

  • type

    OrderType

    Тип заявки

  • time_in_force

    TimeInForce

    Срок действия заявки

  • limit_price

    Decimal

    Необходимо для лимитной и стоп лимитной заявки

  • stop_price

    Decimal

    Необходимо для стоп рыночной и стоп лимитной заявки

  • stop_condition

    StopCondition

    Необходимо для стоп рыночной и стоп лимитной заявки

  • legs

    Leg[]

    required

    Необходимо для мульти лег заявки

  • client_order_id

    string

    Уникальный идентификатор заявки. Автоматически генерируется, если не отправлен. (максимум 20 символов)

  • valid_before

    ValidBefore

    Срок действия условной заявки. Заполняется для заявок с типом ORDER_TYPE_STOP, ORDER_TYPE_STOP_LIMIT

  • comment

    string

    Метка заявки. (максимум 128 символов)

Response

  • order_id

    string

    Идентификатор заявки

  • exec_id

    string

    Идентификатор исполнения

  • status

    OrderStatus

    Статус заявки

  • order

    Order

    Заявка

  • transact_at

    Timestamp

    Дата и время выставления заявки

  • accept_at

    Timestamp

    Дата и время принятия заявки

  • withdraw_at

    Timestamp

    Дата и время отмены заявки

  • initial_quantity

    Decimal

    Начальный объем (заполняется только для биржевой заявки)

  • executed_quantity

    Decimal

    Исполненный объем (заполняется только для биржевой заявки)

  • remaining_quantity

    Decimal

    Оставшийся объем (заполняется только для биржевой заявки)

  • sltp_order

    SLTPOrder

    Информация о SL/TP заявке

|View as Markdown

UnaryОтмена биржевой заявки

/grpc.tradeapi.v1.orders.OrdersService/CancelOrder

Отмена биржевой заявки Пример HTTP запроса: DELETE /v1/accounts/A12345/orders/ORD789012 Authorization: <token>

Request

  • account_id

    string

    Идентификатор аккаунта

  • order_id

    string

    Идентификатор заявки

Response

  • order_id

    string

    Идентификатор заявки

  • exec_id

    string

    Идентификатор исполнения

  • status

    OrderStatus

    Статус заявки

  • order

    Order

    Заявка

  • transact_at

    Timestamp

    Дата и время выставления заявки

  • accept_at

    Timestamp

    Дата и время принятия заявки

  • withdraw_at

    Timestamp

    Дата и время отмены заявки

  • initial_quantity

    Decimal

    Начальный объем (заполняется только для биржевой заявки)

  • executed_quantity

    Decimal

    Исполненный объем (заполняется только для биржевой заявки)

  • remaining_quantity

    Decimal

    Оставшийся объем (заполняется только для биржевой заявки)

  • sltp_order

    SLTPOrder

    Информация о SL/TP заявке

|View as Markdown

UnaryПолучение списка заявок для аккаунта

/grpc.tradeapi.v1.orders.OrdersService/GetOrders

Получение списка заявок для аккаунта Пример HTTP запроса: GET /v1/accounts/A12345/orders Authorization: <token>

Request

  • account_id

    string

    Идентификатор аккаунта

Response

  • orders

    OrderState[]

    required

    Заявки

|View as Markdown

UnaryПолучение информации о конкретном ордере

/grpc.tradeapi.v1.orders.OrdersService/GetOrder

Получение информации о конкретном ордере Пример HTTP запроса: GET /v1/accounts/A12345/orders/ORD789012 Authorization: <token>

Request

  • account_id

    string

    Идентификатор аккаунта

  • order_id

    string

    Идентификатор заявки

Response

  • order_id

    string

    Идентификатор заявки

  • exec_id

    string

    Идентификатор исполнения

  • status

    OrderStatus

    Статус заявки

  • order

    Order

    Заявка

  • transact_at

    Timestamp

    Дата и время выставления заявки

  • accept_at

    Timestamp

    Дата и время принятия заявки

  • withdraw_at

    Timestamp

    Дата и время отмены заявки

  • initial_quantity

    Decimal

    Начальный объем (заполняется только для биржевой заявки)

  • executed_quantity

    Decimal

    Исполненный объем (заполняется только для биржевой заявки)

  • remaining_quantity

    Decimal

    Оставшийся объем (заполняется только для биржевой заявки)

  • sltp_order

    SLTPOrder

    Информация о SL/TP заявке

|View as Markdown

Bidi StreamПодписка на собственные заявки и сделки. Стрим метод

/grpc.tradeapi.v1.orders.OrdersService/SubscribeOrderTrade

Подписка на собственные заявки и сделки. Стрим метод

Request

  • action

    Action

    Изменение статуса подписки: подписка/отписка

  • data_type

    DataType

    Подписка только на заявки/ордера или на все сразу

  • account_id

    string

    Идентификатор аккаунта

Response

  • orders

    OrderState[]

    required

    Заявки

  • trades

    AccountTrade[]

    required

    Сделки

|View as Markdown

Server StreamПодписка на собственные заявки. Стрим метод

/grpc.tradeapi.v1.orders.OrdersService/SubscribeOrders

Подписка на собственные заявки. Стрим метод

Request

  • account_id

    string

    Идентификатор аккаунта

Response

  • orders

    OrderState[]

    required

    Заявки

|View as Markdown

Server StreamПодписка на собственные сделки. Стрим метод

/grpc.tradeapi.v1.orders.OrdersService/SubscribeTrades

Подписка на собственные сделки. Стрим метод

Request

  • account_id

    string

    Идентификатор аккаунта

Response

  • trades

    AccountTrade[]

    required

    Сделки

|View as Markdown

UnaryВыставление SL/TP заявки

/grpc.tradeapi.v1.orders.OrdersService/PlaceSLTPOrder

Выставление SL/TP заявки Пример HTTP запроса: POST /v1/accounts/A12345/sltp-orders Content-Type: application/json Authorization: <token> { "symbol": "SBER@MISX", "side": "SIDE_BUY", "quantity_sl": { "value": "10" }, "sl_price": { "value": "270.00" }, "limit_price": { "value": "269.50" }, "quantity_tp": { "value": "10" }, "tp_price": { "value": "295.50" }, "tp_guard_spread": { "value": "0.5" }, "tp_spread_measure": "TP_SPREAD_MEASURE_VALUE", "valid_before": "VALID_BEFORE_GOOD_TILL_DATE", "valid_expiry_time": "2026-12-31T23:59:59Z", "comment": "my SL/TP order" } Поле account_id берется из URL-пути, остальные поля передаются в теле запроса

Request

  • account_id

    string

    Идентификатор аккаунта

  • symbol

    string

    Символ инструмента

  • side

    Side

    Сторона для обеих заявок

  • quantity_sl

    Decimal

    Количество в шт для SL

  • sl_price

    Decimal

    Параметр условия цены для SL части

  • limit_price

    Decimal

    Если указано, после активации SL будет выставлена лимитная заявка с этой ценой

  • quantity_tp

    Decimal

    Количество в шт для TP

  • tp_price

    Decimal

    Параметр условия цены для TP части

  • tp_guard_spread

    Decimal

    Если указано, после активации TP будет выставлена лимитная заявка с учетом защитного спрэда

  • tp_spread_measure

    TPSpreadMeasure

    Единица измерения величины защитного спреда

  • client_order_id

    string

    Уникальный идентификатор заявки. Автоматически генерируется, если не отправлен. (максимум 20 символов)

  • valid_before

    ValidBefore

    Срок действия условной заявки. Если не заполнено, то по умолчанию выставляется VALID_BEFORE_GOOD_TILL_CANCEL

  • valid_expiry_time

    Timestamp

    Временная метка прекращения действия SL/TP заявки

  • comment

    string

    Метка заявки. (максимум 128 символов)

Response

  • order_id

    string

    Идентификатор заявки

  • exec_id

    string

    Идентификатор исполнения

  • status

    OrderStatus

    Статус заявки

  • order

    Order

    Заявка

  • transact_at

    Timestamp

    Дата и время выставления заявки

  • accept_at

    Timestamp

    Дата и время принятия заявки

  • withdraw_at

    Timestamp

    Дата и время отмены заявки

  • initial_quantity

    Decimal

    Начальный объем (заполняется только для биржевой заявки)

  • executed_quantity

    Decimal

    Исполненный объем (заполняется только для биржевой заявки)

  • remaining_quantity

    Decimal

    Оставшийся объем (заполняется только для биржевой заявки)

  • sltp_order

    SLTPOrder

    Информация о SL/TP заявке

|View as Markdown

UnaryПолучение исторических данных по инструменту (агрегированные свечи)

/grpc.tradeapi.v1.marketdata.MarketDataService/Bars

Получение исторических данных по инструменту (агрегированные свечи) Пример HTTP запроса: GET /v1/instruments/SBER@MISX/bars?timeframe=TIME_FRAME_D&interval.start_time=2023-01-01T00:00:00Z&interval.end_time=2023-01-31T23:59:59Z Authorization: <token> Параметры: - symbol - передается в URL пути - timeframe и interval - передаются как query-параметры

Request

  • symbol

    string

    Символ инструмента

  • timeframe

    TimeFrame

    Необходимый таймфрейм

  • interval

    Interval

    Начало и окончание запрашиваемого периода

Response

  • symbol

    string

    Символ инструмента

  • bars

    Bar[]

    required

    Агрегированная свеча

|View as Markdown

UnaryПолучение последней котировки по инструменту

/grpc.tradeapi.v1.marketdata.MarketDataService/LastQuote

Получение последней котировки по инструменту Пример HTTP запроса: GET /v1/instruments/SBER@MISX/quotes/latest Authorization: <token>

Request

  • symbol

    string

    Символ инструмента

Response

  • symbol

    string

    Символ инструмента

  • quote

    Quote

    Цена последней сделки

|View as Markdown

UnaryПолучение текущего стакана по инструменту

/grpc.tradeapi.v1.marketdata.MarketDataService/OrderBook

Получение текущего стакана по инструменту Пример HTTP запроса: GET /v1/instruments/SBER@MISX/orderbook Authorization: <token>

Request

  • symbol

    string

    Символ инструмента

Response

  • symbol

    string

    Символ инструмента

  • orderbook

    OrderBook

    Стакан

|View as Markdown

UnaryПолучение списка последних сделок по инструменту

/grpc.tradeapi.v1.marketdata.MarketDataService/LatestTrades

Получение списка последних сделок по инструменту Пример HTTP запроса: GET /v1/instruments/SBER@MISX/trades/latest Authorization: <token>

Request

  • symbol

    string

    Символ инструмента

Response

  • symbol

    string

    Символ инструмента

  • trades

    Trade[]

    required

    Список последних сделок

|View as Markdown

Server StreamПодписка на котировки по инструменту. Стрим метод

/grpc.tradeapi.v1.marketdata.MarketDataService/SubscribeQuote

Подписка на котировки по инструменту. Стрим метод

Request

  • symbols

    string[]

    required

    Список символов инструментов

Response

  • quote

    Quote[]

    required

    Список котировок

  • error

    StreamError

    Ошибка стрим сервиса

|View as Markdown

Server StreamПодписка на стакан по инструменту. Стрим метод

/grpc.tradeapi.v1.marketdata.MarketDataService/SubscribeOrderBook

Подписка на стакан по инструменту. Стрим метод

Request

  • symbol

    string

    Символ инструмента

Response

  • order_book

    StreamOrderBook[]

    required

    Список стакан стримов

|View as Markdown

Server StreamПодписка на сделки по инструменту. Стрим метод

/grpc.tradeapi.v1.marketdata.MarketDataService/SubscribeLatestTrades

Подписка на сделки по инструменту. Стрим метод

Request

  • symbol

    string

    Символ инструмента

Response

  • symbol

    string

    Символ инструмента

  • trades

    Trade[]

    required

    Список сделок

|View as Markdown

Server StreamПодписка на агрегированные свечи. Стрим метод

/grpc.tradeapi.v1.marketdata.MarketDataService/SubscribeBars

Подписка на агрегированные свечи. Стрим метод

Request

  • symbol

    string

    Символ инструмента

  • timeframe

    TimeFrame

    Необходимый таймфрейм

Response

  • symbol

    string

    Символ инструмента

  • bars

    Bar[]

    required

    Агрегированная свеча

|View as Markdown

UnaryПолучение списка доступных бирж, названия и mic коды

/grpc.tradeapi.v1.assets.AssetsService/Exchanges

Получение списка доступных бирж, названия и mic коды Пример HTTP запроса: GET /v1/exchanges Authorization: <token>

Response

  • exchanges

    Exchange[]

    required

    Информация о бирже

|View as Markdown

UnaryПолучение списка доступных для торговли инструментов, их описание

/grpc.tradeapi.v1.assets.AssetsService/Assets

Получение списка доступных для торговли инструментов, их описание Пример HTTP запроса: GET /v1/assets Authorization: <token>

Response

  • assets

    Asset[]

    required

    Информация об инструменте

|View as Markdown

UnaryПолучение списка всех инструментов, в том числе индикативных и архивных, их описание

/grpc.tradeapi.v1.assets.AssetsService/AllAssets

Получение списка всех инструментов, в том числе индикативных и архивных, их описание Пример HTTP запроса: GET /v1/assets/all?cursor=56658&only_disabled=true Authorization: <token>

Request

  • cursor

    int64

    Курсор для пагинации. Указывает sec_id инструмента, с которого должен начинаться список. Для первого запроса оставьте поле пустым (значение 0). Для последующих запросов используйте значение next_cursor из предыдущего ответа.

  • only_active

    bool

    Фильтрация по статусу инструмента: выбираются только активные(неархивные) инструменты По умолчанию: false.

  • only_disabled

    bool

    Фильтрация по статусу инструмента: выбираются только неактивные(архивные) инструменты По умолчанию: false.

Response

  • assets

    Asset[]

    required

    Часть списка инструментов

  • next_cursor

    int64

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

|View as Markdown

UnaryПолучение информации по конкретному инструменту

/grpc.tradeapi.v1.assets.AssetsService/GetAsset

Получение информации по конкретному инструменту Пример HTTP запроса: GET /v1/assets/SBER@MISX?account_id=1440399 Authorization: <token> Параметры: - symbol - передается в URL пути - account_id - передаётся как query-параметр

Request

  • symbol

    string

    Символ инструмента

  • account_id

    string

    ID аккаунта для которого будет подбираться информация по инструменту

Response

  • board

    string

    Код режима торгов

  • id

    string

    Идентификатор инструмента

  • ticker

    string

    Тикер инструмента

  • mic

    string

    mic идентификатор биржи

  • isin

    string

    Isin идентификатор инструмента

  • type

    string

    Тип инструмента

  • name

    string

    Наименование инструмента

  • decimals

    int32

    Кол-во десятичных знаков в цене

  • min_step

    int64

    Минимальный шаг цены. Для расчета финального ценового шага: min_step/(10ˆdecimals)

  • lot_size

    Decimal

    Кол-во штук в лоте

  • expiration_date

    Date

    Дата экспирации фьючерса

  • quote_currency

    string

    Валюта котировки, может не совпадать с валютой режима торгов инструмента

  • future_details

    FutureDetails

    Специфичные параметры для инструмента типа "Фьючерс"

  • option_details

    OptionDetails

    Специфичные параметры для инструмента типа "Опцион"

  • bond_details

    BondDetails

    Специфичные параметры для инструмента типа "Облигация"

|View as Markdown

UnaryПолучение торговых параметров по инструменту

/grpc.tradeapi.v1.assets.AssetsService/GetAssetParams

Получение торговых параметров по инструменту Пример HTTP запроса: GET /v1/assets/SBER@MISX/params?account_id=1440399 Authorization: <token> Параметры: - symbol - передается в URL пути - account_id - передаётся как query-параметр

Request

  • symbol

    string

    Символ инструмента

  • account_id

    string

    ID аккаунта для которого будут подбираться торговые параметры

Response

  • symbol

    string

    Символ инструмента

  • account_id

    string

    ID аккаунта для которого подбираются торговые параметры

  • tradeable

    bool

    Доступны ли торговые операции Старое поле, помечено как устаревшее. Клиентам следует перейти на is_tradeable.

  • longable

    Longable

    Доступны ли операции в Лонг

  • shortable

    Shortable

    Доступны ли операции в Шорт

  • long_risk_rate

    Decimal

    Ставка риска для операции в Лонг

  • long_collateral

    Money

    Сумма обеспечения для поддержания позиции Лонг

  • short_risk_rate

    Decimal

    Ставка риска для операции в Шорт

  • short_collateral

    Money

    Сумма обеспечения для поддержания позиции Шорт

  • long_initial_margin

    Money

    Начальные требования, сколько на счету должно быть свободных денежных средств, чтобы открыть лонг позицию, для FORTS счетов равен биржевому ГО

  • short_initial_margin

    Money

    Начальные требования, сколько на счету должно быть свободных денежных средств, чтобы открыть шорт позицию, для FORTS счетов равен биржевому ГО

  • is_tradable

    BoolValue

    Доступны ли торговые операции Новое поле. Позволяет различать false и "не установлено".

  • price_type

    PriceType

    Допустимая цена. Помогает определить можно ли выставлять ордера с отрицательной ценой для финансового инструмента

|View as Markdown

UnaryПолучение цепочки опционов для базового актива

/grpc.tradeapi.v1.assets.AssetsService/OptionsChain

Получение цепочки опционов для базового актива Пример HTTP запроса: GET /v1/assets/SBER@MISX/options Authorization: <token>

Request

  • underlying_symbol

    string

    Символ базового актива опциона

  • root

    string

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

  • expiration_date

    Date

    Опциональный фильтр по дате экспирации опционов. Если параметр не указан, будут возвращены опционы с ближайшей датой экспирации.

Response

  • symbol

    string

    Символ базового актива опциона

  • options

    Option[]

    required

    Информация об опционе

|View as Markdown

UnaryПолучение расписания торгов для инструмента

/grpc.tradeapi.v1.assets.AssetsService/Schedule

Получение расписания торгов для инструмента Пример HTTP запроса: GET /v1/assets/SBER@MISX/schedule Authorization: <token>

Request

  • symbol

    string

    Символ инструмента

Response

  • symbol

    string

    Символ инструмента

  • sessions

    Sessions[]

    required

    Сессии инструмента

|View as Markdown

UnaryПолучение времени на сервере

/grpc.tradeapi.v1.assets.AssetsService/Clock

Получение времени на сервере Пример HTTP запроса: GET /v1/assets/clock Authorization: <token>

Response

  • timestamp

    Timestamp

    Метка времени

|View as Markdown

UnaryПолучить состав биржевого индекса по его символу

/grpc.tradeapi.v1.assets.AssetsService/GetConstituents

Получить состав биржевого индекса по его символу

Request

  • symbol

    string

    Символьный код индекса (например, "SPX@_SP", "NDX@_SCI")

  • cursor

    int64

    Курсор для пагинации. Указывает sec_id инструмента, с которого должен начинаться список. Для первого запроса оставьте поле пустым (значение 0). Для последующих запросов используйте значение next_cursor из предыдущего ответа.

Response

  • constituents

    Constituents[]

    required

    Список компонентов (ценных бумаг), входящих в базу расчета запрошенного индекса

  • next_cursor

    int64

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

|View as Markdown

UnaryПолучение текущих метрик использования для пользователя

/grpc.tradeapi.v1.metrics.UsageMetricsService/GetUsageMetrics

Получение текущих метрик использования для пользователя Пример HTTP запроса: GET /v1/usage Authorization: <token>

Response

  • quotas

    QuotaUsage[]

    required

    Список текущих квот и их использование.

|View as Markdown

UnaryЗапустить генерацию отчета по счету за период

/grpc.tradeapi.v1.reports.ReportsService/CreateAccountReport

Запустить генерацию отчета по счету за период Пример HTTP запроса: POST /v1/report Authorization: <token>

Request

  • date_range

    DateRange

    Временной интервал. Максимальный интервал дат - 92 дня

  • report_form

    ReportForm

    Форма отчета

  • account_id

    int64

    Идентификатор счета

Response

  • report_id

    string

    Идентификатор отчёта

|View as Markdown

UnaryПолучение информации о результате генерации отчета по счету

/grpc.tradeapi.v1.reports.ReportsService/GetAccountReportInfo

Получение информации о результате генерации отчета по счету Пример HTTP запроса: GET /v1/report/01KBMPQ3CEZ4BBCVGBW5JS8S8Y/info Authorization: <token>

Request

  • report_id

    string

    Идентификатор отчёта

Response

  • info

    AccountReportInfo

    Информация о статусе генерации отчёта

|View as Markdown

Server StreamПодписка на информацию о результатах генерации отчета по счету. Стрим метод

/grpc.tradeapi.v1.reports.ReportsService/SubscribeAccountReportInfo

Подписка на информацию о результатах генерации отчета по счету. Стрим метод

Request

  • report_id

    string

    Идентификатор отчёта

Response

  • info

    AccountReportInfo

    Информация о статусе генерации отчёта