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

Методы

StopOrdersService

Сервис для работы со стоп-заявками: выставление, отмена, получение списка стоп-заявок.

Методы сервиса

PostStopOrder

Выставить стоп-заявку.

GetStopOrders

Получить список активных стоп-заявок по счёту.

CancelStopOrder

Отменить стоп-заявку.

Сообщения методов

PostStopOrderRequest

Запрос выставления стоп-заявки.

Field Type Description
figi string Deprecated FIGI-идентификатор инструмента. Используйте instrument_id.
quantity int64 Количество лотов.
price Quotation Цена за 1 инструмент биржевой заявки, которая будет выставлена при срабатывании по достижению stop_price. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
stop_price Quotation Стоп-цена заявки за 1 инструмент. При достижении стоп-цены происходит активация стоп-заявки, в результате чего выставляется биржевая заявка. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
direction StopOrderDirection Направление операции.
account_id string Номер счёта.
expiration_type StopOrderExpirationType Тип экспирации заявки.
stop_order_type StopOrderType Тип заявки.
expire_date google.protobuf.Timestamp Дата и время окончания действия стоп-заявки по UTC. Для ExpirationType = GoodTillDate заполнение обязательно, для GoodTillCancel игнорируется.
instrument_id string Идентификатор инструмента. Принимает значение figi или instrument_uid.
exchange_order_type ExchangeOrderType Тип дочерней биржевой заявки для тейкпрофита.
take_profit_type TakeProfitType Подтип стоп-заявки — TakeProfit.
trailing_data PostStopOrderRequest.TrailingData Массив с параметрами трейлинг-стопа.
price_type PriceType Тип цены.
order_id string Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина — 36 символов.

PostStopOrderRequest.TrailingData

Field Type Description
indent Quotation Отступ.
indent_type TrailingValueType Тип величины отступа.
spread Quotation Размер защитного спреда.
spread_type TrailingValueType Тип величины защитного спреда.

PostStopOrderResponse

Результат выставления стоп-заявки.

Field Type Description
stop_order_id string Уникальный идентификатор стоп-заявки.
order_request_id string Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 — символов.
response_metadata ResponseMetadata Метадата.

GetStopOrdersRequest

Запрос получения списка активных стоп-заявок.

Field Type Description
account_id string Идентификатор счёта клиента.
status StopOrderStatusOption Статус заявок.
from google.protobuf.Timestamp Левая граница.
to google.protobuf.Timestamp Правая граница.

GetStopOrdersResponse

Список активных стоп-заявок.

Field Type Description
stop_orders Массив объектов StopOrder Массив стоп-заявок по счёту.

CancelStopOrderRequest

Запрос отмены выставленной стоп-заявки.

Field Type Description
account_id string Идентификатор счёта клиента.
stop_order_id string Уникальный идентификатор стоп-заявки.

CancelStopOrderResponse

Результат отмены выставленной стоп-заявки.

Field Type Description
time google.protobuf.Timestamp Время отмены заявки по UTC.

StopOrder

Информация о стоп-заявке.

Field Type Description
stop_order_id string Уникальный идентификатор стоп-заявки.
lots_requested int64 Запрошено лотов.
figi string FIGI-идентификатор инструмента.
direction StopOrderDirection Направление операции.
currency string Валюта стоп-заявки.
order_type StopOrderType Тип стоп-заявки.
create_date google.protobuf.Timestamp Дата и время выставления заявки по UTC.
activation_date_time google.protobuf.Timestamp Дата и время конвертации стоп-заявки в биржевую по UTC.
expiration_time google.protobuf.Timestamp Дата и время снятия заявки по UTC.
price MoneyValue Цена заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
stop_price MoneyValue Цена активации стоп-заявки за 1 инструмент. Чтобы получить стоимость лота, нужно умножить на лотность инструмента.
instrument_uid string instrument_uid-идентификатор инструмента.
take_profit_type TakeProfitType Подтип стоп-заявки — TakeProfit.
trailing_data StopOrder.TrailingData Параметры трейлинг-стопа.
status StopOrderStatusOption Статус заявки.
exchange_order_type ExchangeOrderType Тип дочерней биржевой заявки для тейкпрофита.
exchange_order_id string Идентификатор биржевой заявки.

StopOrder.TrailingData

Field Type Description
indent Quotation Отступ.
indent_type TrailingValueType Тип величины отступа.
spread Quotation Размер защитного спреда.
spread_type TrailingValueType Тип величины защитного спреда.
status TrailingStopStatus Статус трейлинг-стопа.
price Quotation Цена исполнения.
extr Quotation Локальный экстремум.

Enums

StopOrderDirection

Направление сделки стоп-заявки.

Name Number Description
STOP_ORDER_DIRECTION_UNSPECIFIED 0 Значение не указано.
STOP_ORDER_DIRECTION_BUY 1 Покупка.
STOP_ORDER_DIRECTION_SELL 2 Продажа.

StopOrderExpirationType

Тип экспирации стоп-заявке.

Name Number Description
STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED 0 Значение не указано.
STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL 1 Действительно до отмены.
STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE 2 Действительно до даты снятия.

StopOrderType

Тип стоп-заявки.

Name Number Description
STOP_ORDER_TYPE_UNSPECIFIED 0 Значение не указано.
STOP_ORDER_TYPE_TAKE_PROFIT 1 Take-profit-заявка.
STOP_ORDER_TYPE_STOP_LOSS 2 Stop-loss-заявка.
STOP_ORDER_TYPE_STOP_LIMIT 3 Stop-limit-заявка.

StopOrderStatusOption

Статус стоп-заяки.

Name Number Description
STOP_ORDER_STATUS_UNSPECIFIED 0 Значение не указано.
STOP_ORDER_STATUS_ALL 1 Все заявки.
STOP_ORDER_STATUS_ACTIVE 2 Активные заявки.
STOP_ORDER_STATUS_EXECUTED 3 Исполненные заявки.
STOP_ORDER_STATUS_CANCELED 4 Отменённые заявки.
STOP_ORDER_STATUS_EXPIRED 5 Истёкшие заявки.

ExchangeOrderType

Тип выставляемой заявки.

Name Number Description
EXCHANGE_ORDER_TYPE_UNSPECIFIED 0 Значение не указано.
EXCHANGE_ORDER_TYPE_MARKET 1 Заявка по рыночной цене.
EXCHANGE_ORDER_TYPE_LIMIT 2 Лимитная заявка.

TakeProfitType

Тип TakeProfit-заявки.

Name Number Description
TAKE_PROFIT_TYPE_UNSPECIFIED 0 Значение не указано.
TAKE_PROFIT_TYPE_REGULAR 1 Обычная заявка, значение по умолчанию.
TAKE_PROFIT_TYPE_TRAILING 2 Трейлинг-стоп.

TrailingValueType

Тип параметров значений трейлинг-стопа.

Name Number Description
TRAILING_VALUE_UNSPECIFIED 0 Значение не указано.
TRAILING_VALUE_ABSOLUTE 1 Абсолютное значение в единицах цены.
TRAILING_VALUE_RELATIVE 2 Относительное значение в процентах.

TrailingStopStatus

Статус трейлинг-стопа.

Name Number Description
TRAILING_STOP_UNSPECIFIED 0 Значение не указано.
TRAILING_STOP_ACTIVE 1 Активный.
TRAILING_STOP_ACTIVATED 2 Активированный.

Нестандартные типы данных

MoneyValue

Денежная сумма в определенной валюте

Field Type Description
currency string Строковый ISO-код валюты
units int64 Целая часть суммы, может быть отрицательным числом
nano int32 Дробная часть суммы, может быть отрицательным числом

Quotation

Котировка - денежная сумма без указания валюты

Field Type Description
units int64 Целая часть суммы, может быть отрицательным числом
nano int32 Дробная часть суммы, может быть отрицательным числом