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

Методы

OperationsService

Сервис предназначен для получения:
1. списка операций по счёту;
2. портфеля по счёту;
3. позиций ценных бумаг на счёте;
4. доступного остатка для вывода средств;
4. получения различных отчётов.

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

GetOperations

Метод получения списка операций по счёту.

GetPortfolio

Метод получения портфеля по счёту.

GetPositions

Метод получения списка позиций по счёту.

GetWithdrawLimits

Метод получения доступного остатка для вывода средств.

GetBrokerReport

Метод получения брокерского отчёта.

GetDividendsForeignIssuer

Метод получения отчёта "Справка о доходах за пределами РФ".

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

OperationsRequest

Запрос получения списка операций по счёту.

Field Type Description
account_id string Идентификатор счёта клиента.
from google.protobuf.Timestamp Начало периода (по UTC).
to google.protobuf.Timestamp Окончание периода (по UTC).
state OperationState Статус запрашиваемых операций.
figi string Figi-идентификатор инструмента для фильтрации.

OperationsResponse

Список операций.

Field Type Description
operations Массив объектов Operation Массив операций.

Operation

Данные по операции.

Field Type Description
id string Идентификатор операции.
parent_operation_id string Идентификатор родительской операции.
currency string Валюта операции.
payment MoneyValue Сумма операции.
price MoneyValue Цена операции за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.
state OperationState Статус операции.
quantity int64 Количество единиц инструмента.
quantity_rest int64 Неисполненный остаток по сделке.
figi string Figi-идентификатор инструмента, связанного с операцией.
instrument_type string Тип инструмента. Возможные значения:
bond — облигация;
share — акция;
currency — валюта;
etf — фонд;
futures — фьючерс.
date google.protobuf.Timestamp Дата и время операции в формате часовом поясе UTC.
type string Текстовое описание типа операции.
operation_type OperationType Тип операции.
trades Массив объектов OperationTrade Массив сделок.

OperationTrade

Сделка по операции.

Field Type Description
trade_id string Идентификатор сделки.
date_time google.protobuf.Timestamp Дата и время сделки в часовом поясе UTC.
quantity int64 Количество инструментов.
price MoneyValue Цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента.

PortfolioRequest

Запрос получения текущего портфеля по счёту.

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

PortfolioResponse

Текущий портфель по счёту.

Field Type Description
total_amount_shares MoneyValue Общая стоимость акций в портфеле в рублях.
total_amount_bonds MoneyValue Общая стоимость облигаций в портфеле в рублях.
total_amount_etf MoneyValue Общая стоимость фондов в портфеле в рублях.
total_amount_currencies MoneyValue Общая стоимость валют в портфеле в рублях.
total_amount_futures MoneyValue Общая стоимость фьючерсов в портфеле в рублях.
expected_yield Quotation Текущая относительная доходность портфеля, в %.
positions Массив объектов PortfolioPosition Список позиций портфеля.

PositionsRequest

Запрос позиций портфеля по счёту.

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

PositionsResponse

Список позиций по счёту.

Field Type Description
money Массив объектов MoneyValue Массив валютных позиций портфеля.
blocked Массив объектов MoneyValue Массив заблокированных валютных позиций портфеля.
securities Массив объектов PositionsSecurities Список ценно-бумажных позиций портфеля.
limits_loading_in_progress bool Признак идущей в данный момент выгрузки лимитов.
futures Массив объектов PositionsFutures Список фьючерсов портфеля.

WithdrawLimitsRequest

Запрос доступного для вывода остатка.

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

WithdrawLimitsResponse

Доступный для вывода остаток.

Field Type Description
money Массив объектов MoneyValue Массив валютных позиций портфеля.
blocked Массив объектов MoneyValue Массив заблокированных валютных позиций портфеля.
blocked_guarantee Массив объектов MoneyValue Заблокировано под гарантийное обеспечение фьючерсов.

PortfolioPosition

Позиции портфеля.

Field Type Description
figi string Figi-идентификатора инструмента.
instrument_type string Тип инструмента.
quantity Quotation Количество инструмента в портфеле в штуках.
average_position_price MoneyValue Средневзвешенная цена позиции. Возможна задержка до секунды для пересчёта.
expected_yield Quotation Текущая рассчитанная доходность позиции.
current_nkd MoneyValue Текущий НКД.
average_position_price_pt Quotation Средняя цена лота в позиции в пунктах (для фьючерсов). Возможна задержка до секунды для пересчёта.
current_price MoneyValue Текущая цена за 1 инструмент. Для получения стоимости лота требуется умножить на лотность инструмента..
average_position_price_fifo MoneyValue Средняя цена лота в позиции по методу FIFO. Возможна задержка до секунды для пересчёта.
quantity_lots Quotation Количество лотов в портфеле.

PositionsSecurities

Баланс позиции ценной бумаги.

Field Type Description
figi string Figi-идентификатор бумаги.
blocked int64 Заблокировано.
balance int64 Текущий незаблокированный баланс.

PositionsFutures

Баланс фьючерса.

Field Type Description
figi string Figi-идентификатор фьючерса.
blocked int64 Заблокировано.
balance int64 Текущий незаблокированный баланс.

BrokerReportRequest

Field Type Description
generate_broker_report_request GenerateBrokerReportRequest
get_broker_report_request GetBrokerReportRequest

BrokerReportResponse

Field Type Description
generate_broker_report_response GenerateBrokerReportResponse
get_broker_report_response GetBrokerReportResponse

GenerateBrokerReportRequest

Field Type Description
account_id string Идентификатор счёта клиента.
from google.protobuf.Timestamp Начало периода в часовом поясе UTC.
to google.protobuf.Timestamp Окончание периода в часовом поясе UTC.

GenerateBrokerReportResponse

Field Type Description
task_id string Идентификатор задачи формирования брокерского отчёта.

GetBrokerReportRequest

Field Type Description
task_id string Идентификатор задачи формирования брокерского отчёта.
page int32 Номер страницы отчета (начинается с 1), значение по умолчанию: 0.

GetBrokerReportResponse

Field Type Description
broker_report Массив объектов BrokerReport
itemsCount int32 Количество записей в отчете.
pagesCount int32 Количество страниц с данными отчета (начинается с 0).
page int32 Текущая страница (начинается с 0).

BrokerReport

Field Type Description
trade_id string Номер сделки.
order_id string Номер поручения.
figi string Figi-идентификатор инструмента.
execute_sign string Признак исполнения.
trade_datetime google.protobuf.Timestamp Дата и время заключения в часовом поясе UTC.
exchange string Торговая площадка.
class_code string Режим торгов.
direction string Вид сделки.
name string Сокращённое наименование актива.
ticker string Код актива.
price MoneyValue Цена за единицу.
quantity int64 Количество.
order_amount MoneyValue Сумма (без НКД).
aci_value Quotation НКД.
total_order_amount MoneyValue Сумма сделки.
broker_commission MoneyValue Комиссия брокера.
exchange_commission MoneyValue Комиссия биржи.
exchange_clearing_commission MoneyValue Комиссия клир. центра.
repo_rate Quotation Ставка РЕПО (%).
party string Контрагент/Брокер.
clear_value_date google.protobuf.Timestamp Дата расчётов в часовом поясе UTC.
sec_value_date google.protobuf.Timestamp Дата поставки в часовом поясе UTC.
broker_status string Статус брокера.
separate_agreement_type string Тип дог.
separate_agreement_number string Номер дог.
separate_agreement_date string Дата дог.
delivery_type string Тип расчёта по сделке.

GetDividendsForeignIssuerRequest

Field Type Description
generate_div_foreign_issuer_report GenerateDividendsForeignIssuerReportRequest Объект запроса формирования отчёта.
get_div_foreign_issuer_report GetDividendsForeignIssuerReportRequest Объект запроса сформированного отчёта.

GetDividendsForeignIssuerResponse

Field Type Description
generate_div_foreign_issuer_report_response GenerateDividendsForeignIssuerReportResponse Объект результата задачи запуска формирования отчёта.
div_foreign_issuer_report GetDividendsForeignIssuerReportResponse Отчёт "Справка о доходах за пределами РФ".

GenerateDividendsForeignIssuerReportRequest

Объект запроса формирования отчёта "Справка о доходах за пределами РФ".

Field Type Description
account_id string Идентификатор счёта клиента.
from google.protobuf.Timestamp Начало периода (по UTC).
to google.protobuf.Timestamp Окончание периода (по UTC).

GetDividendsForeignIssuerReportRequest

Объект запроса сформированного отчёта "Справка о доходах за пределами РФ".

Field Type Description
task_id string Идентификатор задачи формирования отчёта.
page int32 Номер страницы отчета (начинается с 0), значение по умолчанию: 0.

GenerateDividendsForeignIssuerReportResponse

Объект результата задачи запуска формирования отчёта "Справка о доходах за пределами РФ".

Field Type Description
task_id string Идентификатор задачи формирования отчёта.

GetDividendsForeignIssuerReportResponse

Field Type Description
dividends_foreign_issuer_report Массив объектов DividendsForeignIssuerReport
itemsCount int32 Количество записей в отчете.
pagesCount int32 Количество страниц с данными отчета (начинается с 0).
page int32 Текущая страница (начинается с 0).

DividendsForeignIssuerReport

Отчёт "Справка о доходах за пределами РФ".

Field Type Description
record_date google.protobuf.Timestamp Дата фиксации реестра.
payment_date google.protobuf.Timestamp Дата выплаты.
security_name string Наименование ценной бумаги.
isin string ISIN-идентификатор ценной бумаги.
issuer_country string Страна эмитента. Для депозитарных расписок указывается страна эмитента базового актива.
quantity int64 Количество ценных бумаг.
dividend Quotation Выплаты на одну бумагу
external_commission Quotation Комиссия внешних платёжных агентов.
dividend_gross Quotation Сумма до удержания налога.
tax Quotation Сумма налога, удержанного агентом.
dividend_amount Quotation Итоговая сумма выплаты.
currency string Валюта.

Enums

OperationState

Статус запрашиваемых операций.

Name Number Description
OPERATION_STATE_UNSPECIFIED 0 Статус операции не определён
OPERATION_STATE_EXECUTED 1 Исполнена.
OPERATION_STATE_CANCELED 2 Отменена.

OperationType

Тип операции.

Name Number Description
OPERATION_TYPE_UNSPECIFIED 0 Тип операции не определён.
OPERATION_TYPE_INPUT 1 Пополнение брокерского счёта.
OPERATION_TYPE_BOND_TAX 2 Удержание НДФЛ по купонам.
OPERATION_TYPE_OUTPUT_SECURITIES 3 Вывод ЦБ.
OPERATION_TYPE_OVERNIGHT 4 Доход по сделке РЕПО овернайт.
OPERATION_TYPE_TAX 5 Удержание налога.
OPERATION_TYPE_BOND_REPAYMENT_FULL 6 Полное погашение облигаций.
OPERATION_TYPE_SELL_CARD 7 Продажа ЦБ с карты.
OPERATION_TYPE_DIVIDEND_TAX 8 Удержание налога по дивидендам.
OPERATION_TYPE_OUTPUT 9 Вывод денежных средств.
OPERATION_TYPE_BOND_REPAYMENT 10 Частичное погашение облигаций.
OPERATION_TYPE_TAX_CORRECTION 11 Корректировка налога.
OPERATION_TYPE_SERVICE_FEE 12 Удержание комиссии за обслуживание брокерского счёта.
OPERATION_TYPE_BENEFIT_TAX 13 Удержание налога за материальную выгоду.
OPERATION_TYPE_MARGIN_FEE 14 Удержание комиссии за непокрытую позицию.
OPERATION_TYPE_BUY 15 Покупка ЦБ.
OPERATION_TYPE_BUY_CARD 16 Покупка ЦБ с карты.
OPERATION_TYPE_INPUT_SECURITIES 17 Перевод ценных бумаг из другого депозитария.
OPERATION_TYPE_SELL_MARGIN 18 Продажа в результате Margin-call.
OPERATION_TYPE_BROKER_FEE 19 Удержание комиссии за операцию.
OPERATION_TYPE_BUY_MARGIN 20 Покупка в результате Margin-call.
OPERATION_TYPE_DIVIDEND 21 Выплата дивидендов.
OPERATION_TYPE_SELL 22 Продажа ЦБ.
OPERATION_TYPE_COUPON 23 Выплата купонов.
OPERATION_TYPE_SUCCESS_FEE 24 Удержание комиссии SuccessFee.
OPERATION_TYPE_DIVIDEND_TRANSFER 25 Передача дивидендного дохода.
OPERATION_TYPE_ACCRUING_VARMARGIN 26 Зачисление вариационной маржи.
OPERATION_TYPE_WRITING_OFF_VARMARGIN 27 Списание вариационной маржи.
OPERATION_TYPE_DELIVERY_BUY 28 Покупка в рамках экспирации фьючерсного контракта.
OPERATION_TYPE_DELIVERY_SELL 29 Продажа в рамках экспирации фьючерсного контракта.
OPERATION_TYPE_TRACK_MFEE 30 Комиссия за управление по счёту автоследования.
OPERATION_TYPE_TRACK_PFEE 31 Комиссия за результат по счёту автоследования.
OPERATION_TYPE_TAX_PROGRESSIVE 32 Удержание налога по ставке 15%.
OPERATION_TYPE_BOND_TAX_PROGRESSIVE 33 Удержание налога по купонам по ставке 15%.
OPERATION_TYPE_DIVIDEND_TAX_PROGRESSIVE 34 Удержание налога по дивидендам по ставке 15%.
OPERATION_TYPE_BENEFIT_TAX_PROGRESSIVE 35 Удержание налога за материальную выгоду по ставке 15%.
OPERATION_TYPE_TAX_CORRECTION_PROGRESSIVE 36 Корректировка налога по ставке 15%.
OPERATION_TYPE_TAX_REPO_PROGRESSIVE 37 Удержание налога за возмещение по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_TAX_REPO 38 Удержание налога за возмещение по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_HOLD 39 Удержание налога по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_REFUND 40 Возврат налога по сделкам РЕПО.
OPERATION_TYPE_TAX_REPO_HOLD_PROGRESSIVE 41 Удержание налога по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_TAX_REPO_REFUND_PROGRESSIVE 42 Возврат налога по сделкам РЕПО по ставке 15%.
OPERATION_TYPE_DIV_EXT 43 Выплата дивидендов на карту.
OPERATION_TYPE_TAX_CORRECTION_COUPON 44 Корректировка налога по купонам.

SecurityTradingStatus

Name Number Description
SECURITY_TRADING_STATUS_UNSPECIFIED 0 Торговый статус не определён
SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING 1 Недоступен для торгов
SECURITY_TRADING_STATUS_OPENING_PERIOD 2 Период открытия торгов
SECURITY_TRADING_STATUS_CLOSING_PERIOD 3 Период закрытия торгов
SECURITY_TRADING_STATUS_BREAK_IN_TRADING 4 Перерыв в торговле
SECURITY_TRADING_STATUS_NORMAL_TRADING 5 Нормальная торговля
SECURITY_TRADING_STATUS_CLOSING_AUCTION 6 Аукцион закрытия
SECURITY_TRADING_STATUS_DARK_POOL_AUCTION 7 Аукцион крупных пакетов
SECURITY_TRADING_STATUS_DISCRETE_AUCTION 8 Дискретный аукцион
SECURITY_TRADING_STATUS_OPENING_AUCTION_PERIOD 9 Аукцион открытия
SECURITY_TRADING_STATUS_TRADING_AT_CLOSING_AUCTION_PRICE 10 Период торгов по цене аукциона закрытия
SECURITY_TRADING_STATUS_SESSION_ASSIGNED 11 Сессия назначена
SECURITY_TRADING_STATUS_SESSION_CLOSE 12 Сессия закрыта
SECURITY_TRADING_STATUS_SESSION_OPEN 13 Сессия открыта
SECURITY_TRADING_STATUS_DEALER_NORMAL_TRADING 14 Доступна торговля в режиме внутренней ликвидности брокера
SECURITY_TRADING_STATUS_DEALER_BREAK_IN_TRADING 15 Перерыв торговли в режиме внутренней ликвидности брокера
SECURITY_TRADING_STATUS_DEALER_NOT_AVAILABLE_FOR_TRADING 16 Недоступна торговля в режиме внутренней ликвидности брокера

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

MoneyValue

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

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

Quotation

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

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