gRPC-методы
С помощью методов сервиса можно получить:
- информацию об инструментах;
- расписания торговых сессий;
- календарь выплат купонов по облигациям;
- размер гарантийного обеспечения по фьючерсам;
- дивиденды по ценной бумаге.
Протестировать и отправить запросы можно через REST-методы.
Методы сервиса
TradingSchedules
Получить расписания торгов торговых площадок.
Тело запроса — TradingSchedulesRequest
Тело ответа — TradingSchedulesResponse
BondBy
Получить облигации по ее идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — BondResponse
Bonds
Получить список облигаций.
Тело запроса — InstrumentsRequest
Тело ответа — BondsResponse
GetBondCoupons
Получить график выплат купонов по облигации.
Тело запроса — GetBondCouponsRequest
Тело ответа — GetBondCouponsResponse
GetBondEvents
Получить события по облигации
Тело запроса — GetBondEventsRequest
Тело ответа — GetBondEventsResponse
CurrencyBy
Получить валюту по ее идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — CurrencyResponse
Currencies
Получить список валют.
Тело запроса — InstrumentsRequest
Тело ответа — CurrenciesResponse
EtfBy
Получить инвестиционный фонд по его идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — EtfResponse
Etfs
Получить список инвестиционных фондов.
Тело запроса — InstrumentsRequest
Тело ответа — EtfsResponse
FutureBy
Получить фьючерс по его идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — FutureResponse
Futures
Получить список фьючерсов.
Тело запроса — InstrumentsRequest
Тело ответа — FuturesResponse
OptionBy
Получить опцион по его идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — OptionResponse
Options
Deprecated Получить списка опционов.
Тело запроса — InstrumentsRequest
Тело ответа — OptionsResponse
OptionsBy
Получить список опционов.
Тело запроса — FilterOptionsRequest
Тело ответа — OptionsResponse
ShareBy
Получить акцию по ее идентификатору.
Тело запроса — InstrumentRequest
Тело ответа — ShareResponse
Shares
Получить список акций.
Тело запроса — InstrumentsRequest
Тело ответа — SharesResponse
Indicatives
Получить индикативные инструменты — индексы, товары и другие.
Тело запроса — IndicativesRequest
Тело ответа — IndicativesResponse
GetAccruedInterests
Получить накопленный купонный доход по облигации.
Тело запроса — GetAccruedInterestsRequest
Тело ответа — GetAccruedInterestsResponse
GetFuturesMargin
Получить размера гарантийного обеспечения по фьючерсам.
Тело запроса — GetFuturesMarginRequest
Тело ответа — GetFuturesMarginResponse
GetInstrumentBy
Получить основную информацию об инструменте.
Тело запроса — InstrumentRequest
Тело ответа — InstrumentResponse
GetDividends
Получить события выплаты дивидендов по инструменту.
Тело запроса — GetDividendsRequest
Тело ответа — GetDividendsResponse
GetAssetBy
Получить актив по его идентификатору.
Тело запроса — AssetRequest
Тело ответа — AssetResponse
GetAssets
Получить список активов. Метод работает для всех инструментов, кроме срочных — фьючерсов и опционов.
Тело запроса — AssetsRequest
Тело ответа — AssetsResponse
GetFavorites
Получить список избранных инструментов.
Тело запроса — GetFavoritesRequest
Тело ответа — GetFavoritesResponse
EditFavorites
Отредактировать список избранных инструментов.
Тело запроса — EditFavoritesRequest
Тело ответа — EditFavoritesResponse
GetCountries
Получить список стран.
Тело запроса — GetCountriesRequest
Тело ответа — GetCountriesResponse
FindInstrument
Найти инструмент.
Тело запроса — FindInstrumentRequest
Тело ответа — FindInstrumentResponse
GetBrands
Получить список брендов.
Тело запроса — GetBrandsRequest
Тело ответа — GetBrandsResponse
GetBrandBy
Получить бренд по его идентификатору.
Тело запроса — GetBrandRequest
Тело ответа — Brand
GetAssetFundamentals
Получить фундаментальные показатели по активу.
Тело запроса — GetAssetFundamentalsRequest
Тело ответа — GetAssetFundamentalsResponse
GetAssetReports
Получить расписания выхода отчетностей эмитентов.
Тело запроса — GetAssetReportsRequest
Тело ответа — GetAssetReportsResponse
GetConsensusForecasts
Получить мнения аналитиков по инструменту.
Тело запроса — GetConsensusForecastsRequest]
Тело ответа — GetConsensusForecastsResponse
GetForecastBy
Получить прогнозов инвестдомов по инструменту.
Тело запроса — GetForecastRequest
Тело ответа — GetForecastResponse
Сообщения методов
TradingSchedulesRequest
Запрос расписания торгов.
| Field | Type | Description |
|---|---|---|
| exchange | string | Наименование биржи или расчетного календаря. Если не передается, возвращается информация по всем доступным торговым площадкам. |
| from | google.protobuf.Timestamp | Начало периода по UTC. |
| to | google.protobuf.Timestamp | Окончание периода по UTC. |
TradingSchedulesResponse
Список торговых площадок.
| Field | Type | Description |
|---|---|---|
| exchanges | Массив объектов TradingSchedule | Список торговых площадок и режимов торгов. |
TradingSchedule
Данные по торговой площадке.
| Field | Type | Description |
|---|---|---|
| exchange | string | Наименование торговой площадки. |
| days | Массив объектов TradingDay | Массив с торговыми и неторговыми днями. |
TradingDay
Информация о времени торгов.
| Field | Type | Description |
|---|---|---|
| date | google.protobuf.Timestamp | Дата. |
| is_trading_day | bool | Признак торгового дня на бирже. |
| start_time | google.protobuf.Timestamp | Время начала торгов по UTC. |
| end_time | google.protobuf.Timestamp | Время окончания торгов по UTC. |
| opening_auction_start_time | google.protobuf.Timestamp | Время начала аукциона открытия по UTC. |
| closing_auction_end_time | google.protobuf.Timestamp | Время окончания аукциона закрытия по UTC. |
| evening_opening_auction_start_time | google.protobuf.Timestamp | Время начала аукциона открытия вечерней сессии по UTC. |
| evening_start_time | google.protobuf.Timestamp | Время начала вечерней сессии по UTC. |
| evening_end_time | google.protobuf.Timestamp | Время окончания вечерней сессии по UTC. |
| clearing_start_time | google.protobuf.Timestamp | Время начала основного клиринга по UTC. |
| clearing_end_time | google.protobuf.Timestamp | Время окончания основного клиринга по UTC. |
| premarket_start_time | google.protobuf.Timestamp | Время начала премаркета по UTC. |
| premarket_end_time | google.protobuf.Timestamp | Время окончания премаркета по UTC. |
| closing_auction_start_time | google.protobuf.Timestamp | Время начала аукциона закрытия по UTC. |
| opening_auction_end_time | google.protobuf.Timestamp | Время окончания аукциона открытия по UTC. |
| intervals | Массив объектов TradingInterval | Торговые интервалы. |
InstrumentRequest
Запрос получения инструмента по идентификатору.
| Field | Type | Description |
|---|---|---|
| id_type | InstrumentIdType | Тип идентификатора инструмента. Возможные значения — figi, ticker. Подробнее об идентификации инструментов. |
| class_code | string | Идентификатор class_code. Обязательный, если id_type = ticker. |
| id | string | Идентификатор запрашиваемого инструмента. |
InstrumentsRequest
Запрос получения инструментов.
| Field | Type | Description |
|---|---|---|
| instrument_status | InstrumentStatus | Статус запрашиваемых инструментов. Возможные значения. |
| instrument_exchange | InstrumentExchangeType | Тип площадки торговли. Возможные значения. |
FilterOptionsRequest
Параметры фильтрации опционов.
| Field | Type | Description |
|---|---|---|
| basic_asset_uid | string | Идентификатор базового актива опциона. Обязательный параметр. |
| basic_asset_position_uid | string | Идентификатор позиции базового актива опциона. |
BondResponse
Информация об облигации.
| Field | Type | Description |
|---|---|---|
| instrument | Bond | Информация об облигации. |
BondsResponse
Список облигаций.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Bond | Массив облигаций. |
GetBondCouponsRequest
Запрос купонов по облигации.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| from | google.protobuf.Timestamp | Начало запрашиваемого периода по UTC. Фильтрация по coupon_date — дата выплаты купона. |
| to | google.protobuf.Timestamp | Окончание запрашиваемого периода по UTC. Фильтрация по coupon_date — дата выплаты купона. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
GetBondCouponsResponse
Купоны по облигации.
| Field | Type | Description |
|---|---|---|
| events | Массив объектов Coupon |
GetBondEventsRequest
События по облигации.
| Field | Type | Description |
|---|---|---|
| from | google.protobuf.Timestamp | Начало запрашиваемого периода по UTC. |
| to | google.protobuf.Timestamp | Окончание запрашиваемого периода по UTC. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
| type | GetBondEventsRequest.EventType | Тип события |
GetBondEventsResponse
Объект передачи информации о событии облигации.
| Field | Type | Description |
|---|---|---|
| events | Массив объектов GetBondEventsResponse.BondEvent |
GetBondEventsResponse.BondEvent
| Field | Type | Description |
|---|---|---|
| instrument_id | string | Идентификатор инструмента. |
| event_number | int32 | Номер события для данного типа события. |
| event_date | google.protobuf.Timestamp | Дата события. |
| event_type | GetBondEventsRequest.EventType | Тип события. |
| event_total_vol | Quotation | Полное количество бумаг, задействованных в событии. |
| fix_date | google.protobuf.Timestamp | Дата фиксации владельцев для участия в событии. |
| rate_date | google.protobuf.Timestamp | Дата определения даты или факта события. |
| default_date | google.protobuf.Timestamp | Дата дефолта, если применимо. |
| real_pay_date | google.protobuf.Timestamp | Дата реального исполнения обязательства. |
| pay_date | google.protobuf.Timestamp | Дата выплаты. |
| pay_one_bond | MoneyValue | Выплата на одну облигацию. |
| money_flow_val | MoneyValue | Выплаты на все бумаги, задействованные в событии. |
| execution | string | Признак исполнения. |
| operation_type | string | Тип операции. |
| value | Quotation | Стоимость операции — ставка купона, доля номинала, цена выкупа или коэффициент конвертации. |
| note | string | Примечание. |
| convert_to_fin_tool_id | string | ID выпуска бумаг, в который произведена конвертация (для конвертаций). |
| coupon_start_date | google.protobuf.Timestamp | Начало купонного периода. |
| coupon_end_date | google.protobuf.Timestamp | Окончание купонного периода. |
| coupon_period | int32 | Купонный период. |
| coupon_interest_rate | Quotation | Ставка купона, процентов годовых. |
Coupon
Объект передачи информации о купоне облигации.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| coupon_date | google.protobuf.Timestamp | Дата выплаты купона. |
| coupon_number | int64 | Номер купона. |
| fix_date | google.protobuf.Timestamp | Дата фиксации реестра для выплаты купона — опционально. |
| pay_one_bond | MoneyValue | Выплата на одну облигацию. |
| coupon_type | CouponType | Тип купона. |
| coupon_start_date | google.protobuf.Timestamp | Начало купонного периода. |
| coupon_end_date | google.protobuf.Timestamp | Окончание купонного периода. |
| coupon_period | int32 | Купонный период в днях. |
CurrencyResponse
Данные по валюте.
| Field | Type | Description |
|---|---|---|
| instrument | Currency | Информация о валюте. |
CurrenciesResponse
Данные по валютам.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Currency | Массив валют. |
EtfResponse
Данные по фонду.
| Field | Type | Description |
|---|---|---|
| instrument | Etf | Информация о фонде. |
EtfsResponse
Данные по фондам.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Etf | Массив фондов. |
FutureResponse
Данные по фьючерсу.
| Field | Type | Description |
|---|---|---|
| instrument | Future | Информация о фьючерсу. |
FuturesResponse
Данные по фьючерсам.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Future | Массив фьючерсов. |
OptionResponse
Данные по опциону.
| Field | Type | Description |
|---|---|---|
| instrument | Option | Информация по опциону. |
OptionsResponse
Данные по опционам.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Option | Массив данных по опциону. |
Option
Опцион.
| Field | Type | Description |
|---|---|---|
| uid | string | Уникальный идентификатор инструмента. |
| position_uid | string | Уникальный идентификатор позиции. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код. |
| basic_asset_position_uid | string | Уникальный идентификатор позиции основного инструмента. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| direction | OptionDirection | Направление опциона. |
| payment_type | OptionPaymentType | Тип расчетов по опциону. |
| style | OptionStyle | Стиль опциона. |
| settlement_type | OptionSettlementType | Способ исполнения опциона. |
| name | string | Название инструмента. |
| currency | string | Валюта. |
| settlement_currency | string | Валюта, в которой оценивается контракт. |
| asset_type | string | Тип актива. |
| basic_asset | string | Основной актив. |
| exchange | string | Tорговая площадка (секция биржи). |
| country_of_risk | string | Код страны рисков. |
| country_of_risk_name | string | Наименование страны рисков. |
| sector | string | Сектор экономики. |
| brand | BrandData | Информация о бренде. |
| lot | int32 | Количество бумаг в лоте. |
| basic_asset_size | Quotation | Размер основного актива. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| min_price_increment | Quotation | Минимальный шаг цены. |
| strike_price | MoneyValue | Цена страйка. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| expiration_date | google.protobuf.Timestamp | Дата истечения срока в формате UTC. |
| first_trade_date | google.protobuf.Timestamp | Дата начала обращения контракта в формате UTC. |
| last_trade_date | google.protobuf.Timestamp | Дата исполнения в формате UTC. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи в формате UTC. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи в формате UTC. |
| short_enabled_flag | bool | Признак доступности для операций шорт. |
| for_iis_flag | bool | Возможность покупки или продажи на ИИС. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| api_trade_available_flag | bool | Возможность торговать инструментом через API. |
ShareResponse
Данные по акции.
| Field | Type | Description |
|---|---|---|
| instrument | Share | Информация об акции. |
SharesResponse
Данные по акциям.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов Share | Массив акций. |
Bond
Объект передачи информации об облигации.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| isin | string | ISIN-идентификатор инструмента. |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее. |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций в шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| coupon_quantity_per_year | int32 | Количество выплат по купонам в год. |
| maturity_date | google.protobuf.Timestamp | Дата погашения облигации по UTC. |
| nominal | MoneyValue | Номинал облигации. |
| initial_nominal | MoneyValue | Первоначальный номинал облигации. |
| state_reg_date | google.protobuf.Timestamp | Дата выпуска облигации по UTC. |
| placement_date | google.protobuf.Timestamp | Дата размещения по UTC. |
| placement_price | MoneyValue | Цена размещения. |
| aci_value | MoneyValue | Значение НКД (накопленного купонного дохода) на дату. |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| sector | string | Сектор экономики. |
| issue_kind | string | Форма выпуска. Возможные значения: documentary — документарная; non_documentary — бездокументарная. |
| issue_size | int64 | Размер выпуска. |
| issue_size_plan | int64 | Плановый размер выпуска. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| floating_coupon_flag | bool | Признак облигации с плавающим купоном. |
| perpetual_flag | bool | Признак бессрочной облигации. |
| amortization_flag | bool | Признак облигации с амортизацией долга. |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов. (биржа) |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| asset_uid | string | Уникальный идентификатор актива. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| subordinated_flag | bool | Признак субординированной облигации. |
| liquidity_flag | bool | Флаг достаточной ликвидности. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| risk_level | RiskLevel | Уровень риска. |
| brand | BrandData | Информация о бренде. |
| bond_type | BondType | Тип облигации. |
| call_date | google.protobuf.Timestamp | Дата погашения облигации. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
Currency
Объект передачи информации о валюте.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| isin | string | ISIN-идентификатор инструмента. |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее. |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций в шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| nominal | MoneyValue | Номинал. |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| iso_currency_name | string | Строковый ISO-код валюты. |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| brand | BrandData | Информация о бренде. |
Etf
Объект передачи информации об инвестиционном фонде.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| isin | string | ISIN-идентификатор инструмента. |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее. |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций в шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| fixed_commission | Quotation | Размер фиксированной комиссии фонда. |
| focus_type | string | Возможные значения: equity — акции; fixed_income — облигации; mixed_allocation — смешанный; money_market — денежный рынок; real_estate — недвижимость; commodity — товары; specialty — специальный; private_equity — private equity; alternative_investment — альтернативные инвестиции. |
| released_date | google.protobuf.Timestamp | Дата выпуска по UTC. |
| num_shares | Quotation | Количество паев фонда в обращении. |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| sector | string | Сектор экономики. |
| rebalancing_freq | string | Частота ребалансировки. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| asset_uid | string | Уникальный идентификатор актива. |
| instrument_exchange | InstrumentExchangeType | Тип площадки торговли. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | ФлагФлаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| liquidity_flag | bool | Флаг достаточной ликвидности. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| brand | BrandData | Информация о бренде. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
Future
Объект передачи информации о фьючерсе.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее. |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| first_trade_date | google.protobuf.Timestamp | Дата начала обращения контракта по UTC. |
| last_trade_date | google.protobuf.Timestamp | Дата по UTC, до которой возможно проведение операций с фьючерсом. |
| futures_type | string | Тип фьючерса. Возможные значения: physical_delivery — физические поставки; cash_settlement — денежный эквивалент. |
| asset_type | string | Тип актива. Возможные значения: commodity — товар; currency — валюта; security — ценная бумага; index — индекс. |
| basic_asset | string | Основной актив. |
| basic_asset_size | Quotation | Размер основного актива. |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| sector | string | Сектор экономики. |
| expiration_date | google.protobuf.Timestamp | Дата истечения срока в часов поясе UTC. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| basic_asset_position_uid | string | Уникальный идентификатор позиции основного инструмента. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| initial_margin_on_buy | MoneyValue | Гарантийное обеспечение при покупке. |
| initial_margin_on_sell | MoneyValue | Гарантийное обеспечение при продаже. |
| min_price_increment_amount | Quotation | Стоимость шага цены. |
| brand | BrandData | Информация о бренде. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
Share
Объект передачи информации об акции.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| isin | string | ISIN-идентификатор инструмента. |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций в шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| ipo_date | google.protobuf.Timestamp | Дата IPO акции по UTC. |
| issue_size | int64 | Размер выпуска. |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| sector | string | Сектор экономики. |
| issue_size_plan | int64 | Плановый размер выпуска. |
| nominal | MoneyValue | Номинал. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| div_yield_flag | bool | Признак наличия дивидендной доходности. |
| share_type | ShareType | Тип акции. Возможные значения — [ShareType](/invest/services/instruments/methods#sharetype). |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| asset_uid | string | Уникальный идентификатор актива. |
| instrument_exchange | InstrumentExchangeType | Тип площадки торговли. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| liquidity_flag | bool | Флаг достаточной ликвидности. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| brand | BrandData | Информация о бренде. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
GetAccruedInterestsRequest
Запрос НКД по облигации.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| from | google.protobuf.Timestamp | Начало запрашиваемого периода по UTC. |
| to | google.protobuf.Timestamp | Окончание запрашиваемого периода по UTC. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
GetAccruedInterestsResponse
НКД облигации.
| Field | Type | Description |
|---|---|---|
| accrued_interests | Массив объектов AccruedInterest | Массив операций начисления купонов. |
AccruedInterest
Операция начисления купонов.
| Field | Type | Description |
|---|---|---|
| date | google.protobuf.Timestamp | Дата и время выплаты по UTC. |
| value | Quotation | Величина выплаты. |
| value_percent | Quotation | Величина выплаты в процентах от номинала. |
| nominal | Quotation | Номинал облигации. |
GetFuturesMarginRequest
Запрос информации о фьючерсе
| Field | Type | Description |
|---|---|---|
| figi | string | Идентификатор инструмента. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
GetFuturesMarginResponse
Данные по фьючерсу
| Field | Type | Description |
|---|---|---|
| initial_margin_on_buy | MoneyValue | Гарантийное обеспечение при покупке. |
| initial_margin_on_sell | MoneyValue | Гарантийное обеспечение при продаже. |
| min_price_increment | Quotation | Шаг цены. |
| min_price_increment_amount | Quotation | Стоимость шага цены. |
InstrumentResponse
Данные по инструменту.
| Field | Type | Description |
|---|---|---|
| instrument | Instrument | Основная информация об инструменте. |
Instrument
Объект передачи основной информации об инструменте.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код инструмента. |
| isin | string | ISIN-идентификатор инструмента. |
| lot | int32 | Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее. |
| currency | string | Валюта расчетов. |
| klong | Quotation | Коэффициент ставки риска длинной позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| kshort | Quotation | Коэффициент ставки риска короткой позиции по клиенту. 2 – клиент со стандартным уровнем риска (КСУР); 1 – клиент с повышенным уровнем риска (КПУР). |
| dlong | Quotation | Ставка риска начальной маржи для КСУР лонг. Подробнее про ставки риска. |
| dshort | Quotation | Ставка риска начальной маржи для КСУР шорт. Подробнее про ставки риска. |
| dlong_min | Quotation | Ставка риска начальной маржи для КПУР лонг. Подробнее про ставки риска. |
| dshort_min | Quotation | Ставка риска начальной маржи для КПУР шорт. Подробнее про ставки риска. |
| short_enabled_flag | bool | Признак доступности для операций в шорт. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| country_of_risk | string | Код страны риска — то есть страны, в которой компания ведет основной бизнес. |
| country_of_risk_name | string | Наименование страны риска — то есть страны, в которой компания ведет основной бизнес. |
| instrument_type | string | Тип инструмента. |
| trading_status | SecurityTradingStatus | Текущий режим торгов инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
| min_price_increment | Quotation | Шаг цены. |
| api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
| uid | string | Уникальный идентификатор инструмента. |
| real_exchange | RealExchange | Реальная площадка исполнения расчетов (биржа). |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| asset_uid | string | Уникальный идентификатор актива. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| instrument_kind | InstrumentType | Тип инструмента. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| brand | BrandData | Информация о бренде. |
| dlong_client | Quotation | Ставка риска в лонг с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
| dshort_client | Quotation | Ставка риска в шорт с учетом текущего уровня риска портфеля клиента. Подробнее про ставки риска. |
GetDividendsRequest
Запрос дивидендов.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| from | google.protobuf.Timestamp | Начало запрашиваемого периода по UTC. Фильтрация происходит по параметру record_date — дата фиксации реестра. |
| to | google.protobuf.Timestamp | Окончание запрашиваемого периода по UTC. Фильтрация происходит по параметру record_date — дата фиксации реестра. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
GetDividendsResponse
Дивиденды.
| Field | Type | Description |
|---|---|---|
| dividends | Массив объектов Dividend |
Dividend
Информация о выплате.
| Field | Type | Description |
|---|---|---|
| dividend_net | MoneyValue | Величина дивиденда на 1 ценную бумагу (включая валюту). |
| payment_date | google.protobuf.Timestamp | Дата фактических выплат по UTC. |
| declared_date | google.protobuf.Timestamp | Дата объявления дивидендов по UTC. |
| last_buy_date | google.protobuf.Timestamp | Последний день (включительно) покупки для получения выплаты по UTC. |
| dividend_type | string | Тип выплаты. Возможные значения: Regular Cash – регулярные выплаты, Cancelled – выплата отменена, Daily Accrual – ежедневное начисление, Return of Capital – возврат капитала, прочие типы выплат. |
| record_date | google.protobuf.Timestamp | Дата фиксации реестра по UTC. |
| regularity | string | Регулярность выплаты. Возможные значения: Annual – ежегодная, Semi-Anl – каждые полгода, прочие типы выплат. |
| close_price | MoneyValue | Цена закрытия инструмента на момент ex_dividend_date. |
| yield_value | Quotation | Величина доходности. |
| created_at | google.protobuf.Timestamp | Дата и время создания записи по UTC. |
AssetRequest
Запрос актива по идентификатору.
| Field | Type | Description |
|---|---|---|
| id | string | UID-идентификатор актива. |
AssetResponse
Данные по активу.
| Field | Type | Description |
|---|---|---|
| asset | AssetFull | Актив. |
AssetsRequest
Запрос списка активов.
| Field | Type | Description |
|---|---|---|
| instrument_type | InstrumentType | |
| instrument_status | InstrumentStatus | Статус запрашиваемых инструментов. Возможные значения. |
AssetsResponse
Список активов.
| Field | Type | Description |
|---|---|---|
| assets | Массив объектов Asset | Активы. |
AssetFull
| Field | Type | Description |
|---|---|---|
| uid | string | Уникальный идентификатор актива. |
| type | AssetType | Тип актива. |
| name | string | Наименование актива. |
| name_brief | string | Короткое наименование актива. |
| description | string | Описание актива. |
| deleted_at | google.protobuf.Timestamp | Дата и время удаления актива. |
| required_tests | Массив объектов string | Тестирование клиентов. |
| currency | AssetCurrency | Валюта. Обязательно и заполняется только для type = ASSET_TYPE_CURRENCY. |
| security | AssetSecurity | Ценная бумага. Обязательно и заполняется только для type = ASSET_TYPE_SECURITY. |
| gos_reg_code | string | Номер государственной регистрации. |
| cfi | string | Код CFI. |
| code_nsd | string | Код НРД инструмента. |
| status | string | Статус актива. |
| brand | Brand | Бренд. |
| updated_at | google.protobuf.Timestamp | Дата и время последнего обновления записи. |
| br_code | string | Код типа ц.б. по классификации Банка России. |
| br_code_name | string | Наименование кода типа ц.б. по классификации Банка России. |
| instruments | Массив объектов AssetInstrument | Массив идентификаторов инструментов. |
Asset
Информация об активе.
| Field | Type | Description |
|---|---|---|
| uid | string | Уникальный идентификатор актива. |
| type | AssetType | Тип актива. |
| name | string | Наименование актива. |
| instruments | Массив объектов AssetInstrument | Массив идентификаторов инструментов. |
AssetCurrency
Валюта.
| Field | Type | Description |
|---|---|---|
| base_currency | string | ISO-код валюты. |
AssetSecurity
Ценная бумага.
| Field | Type | Description |
|---|---|---|
| isin | string | ISIN-идентификатор ценной бумаги. |
| type | string | Тип ценной бумаги. |
| instrument_kind | InstrumentType | Тип инструмента. |
| share | AssetShare | Акция. Заполняется только для акций — тип актива asset.type = ASSET_TYPE_SECURITY и security.type = share. |
| bond | AssetBond | Облигация. Заполняется только для облигаций — тип актива asset.type = ASSET_TYPE_SECURITY и security.type = bond. |
| sp | AssetStructuredProduct | Структурная нота. Заполняется только для структурных продуктов — тип актива asset.type = ASSET_TYPE_SECURITY и security.type = sp. |
| etf | AssetEtf | Фонд. Заполняется только для фондов — тип актива asset.type = ASSET_TYPE_SECURITY и security.type = etf. |
| clearing_certificate | AssetClearingCertificate | Клиринговый сертификат участия. Заполняется только для клиринговых сертификатов — тип актива asset.type = ASSET_TYPE_SECURITY и security.type = clearing_certificate. |
AssetShare
Акция.
| Field | Type | Description |
|---|---|---|
| type | ShareType | Тип акции. |
| issue_size | Quotation | Объем выпуска (шт.). |
| nominal | Quotation | Номинал. |
| nominal_currency | string | Валюта номинала. |
| primary_index | string | Индекс (Bloomberg). |
| dividend_rate | Quotation | Ставка дивиденда (для привилегированных акций). |
| preferred_share_type | string | Тип привилегированных акций. |
| ipo_date | google.protobuf.Timestamp | Дата IPO. |
| registry_date | google.protobuf.Timestamp | Дата регистрации. |
| div_yield_flag | bool | Признак наличия дивидендной доходности. |
| issue_kind | string | Форма выпуска ФИ. |
| placement_date | google.protobuf.Timestamp | Дата размещения акции. |
| repres_isin | string | ISIN базового актива. |
| issue_size_plan | Quotation | Объявленное количество, шт. |
| total_float | Quotation | Количество акций в свободном обращении. |
AssetBond
Облигация.
| Field | Type | Description |
|---|---|---|
| current_nominal | Quotation | Текущий номинал. |
| borrow_name | string | Наименование заемщика. |
| issue_size | Quotation | Объем эмиссии облигации (стоимость). |
| nominal | Quotation | Номинал облигации. |
| nominal_currency | string | Валюта номинала. |
| issue_kind | string | Форма выпуска облигации. |
| interest_kind | string | Форма дохода облигации. |
| coupon_quantity_per_year | int32 | Количество выплат в год. |
| indexed_nominal_flag | bool | Признак облигации с индексируемым номиналом. |
| subordinated_flag | bool | Признак субординированной облигации. |
| collateral_flag | bool | Признак обеспеченной облигации. |
| tax_free_flag | bool | Признак показывает, что купоны облигации не облагаются налогом — для mass market. |
| amortization_flag | bool | Признак облигации с амортизацией долга. |
| floating_coupon_flag | bool | Признак облигации с плавающим купоном. |
| perpetual_flag | bool | Признак бессрочной облигации. |
| maturity_date | google.protobuf.Timestamp | Дата погашения облигации. |
| return_condition | string | Описание и условия получения дополнительного дохода. |
| state_reg_date | google.protobuf.Timestamp | Дата выпуска облигации. |
| placement_date | google.protobuf.Timestamp | Дата размещения облигации. |
| placement_price | Quotation | Цена размещения облигации. |
| issue_size_plan | Quotation | Объявленное количество, шт. |
AssetStructuredProduct
Структурная нота.
| Field | Type | Description |
|---|---|---|
| borrow_name | string | Наименование заемщика. |
| nominal | Quotation | Номинал. |
| nominal_currency | string | Валюта номинала. |
| type | StructuredProductType | Тип структурной ноты. |
| logic_portfolio | string | Стратегия портфеля. |
| asset_type | AssetType | Тип базового актива. |
| basic_asset | string | Вид базового актива в зависимости от типа базового актива. |
| safety_barrier | Quotation | Барьер сохранности в процентах. |
| maturity_date | google.protobuf.Timestamp | Дата погашения. |
| issue_size_plan | Quotation | Объявленное количество, шт. |
| issue_size | Quotation | Объем размещения. |
| placement_date | google.protobuf.Timestamp | Дата размещения ноты. |
| issue_kind | string | Форма выпуска. |
AssetEtf
Фонд.
| Field | Type | Description |
|---|---|---|
| total_expense | Quotation | Суммарные расходы фонда в процентах. |
| hurdle_rate | Quotation | Барьерная ставка доходности, после которой фонд имеет право на perfomance fee — в процентах. |
| performance_fee | Quotation | Комиссия за успешные результаты фонда в процентах. |
| fixed_commission | Quotation | Фиксированная комиссия за управление в процентах. |
| payment_type | string | Тип распределения доходов от выплат по бумагам. |
| watermark_flag | bool | Признак необходимости выхода фонда в плюс для получения комиссии. |
| buy_premium | Quotation | Премия (надбавка к цене) при покупке доли в фонде — в процентах. |
| sell_discount | Quotation | Ставка дисконта (вычет из цены) при продаже доли в фонде — в процентах. |
| rebalancing_flag | bool | Признак ребалансируемости портфеля фонда. |
| rebalancing_freq | string | Периодичность ребалансировки. |
| management_type | string | Тип управления. |
| primary_index | string | Индекс, который реплицирует (старается копировать) фонд. |
| focus_type | string | База ETF. |
| leveraged_flag | bool | Признак использования заемных активов (плечо). |
| num_share | Quotation | Количество акций в обращении. |
| ucits_flag | bool | Признак обязательства по отчетности перед регулятором. |
| released_date | google.protobuf.Timestamp | Дата выпуска. |
| description | string | Описание фонда. |
| primary_index_description | string | Описание индекса, за которым следует фонд. |
| primary_index_company | string | Основные компании, в которые вкладывается фонд. |
| index_recovery_period | Quotation | Срок восстановления индекса после просадки. |
| inav_code | string | IVAV-код. |
| div_yield_flag | bool | Признак наличия дивидендной доходности. |
| expense_commission | Quotation | Комиссия на покрытие расходов фонда в процентах. |
| primary_index_tracking_error | Quotation | Ошибка следования за индексом в процентах. |
| rebalancing_plan | string | Плановая ребалансировка портфеля. |
| tax_rate | string | Ставки налогообложения дивидендов и купонов. |
| rebalancing_dates | Массив объектов google.protobuf.Timestamp | Даты ребалансировок. |
| issue_kind | string | Форма выпуска. |
| nominal | Quotation | Номинал. |
| nominal_currency | string | Валюта номинала. |
AssetClearingCertificate
Клиринговый сертификат участия.
| Field | Type | Description |
|---|---|---|
| nominal | Quotation | Номинал. |
| nominal_currency | string | Валюта номинала. |
Brand
Бренд.
| Field | Type | Description |
|---|---|---|
| uid | string | UID-идентификатор бренда. |
| name | string | Наименование бренда. |
| description | string | Описание. |
| info | string | Информация о бренде. |
| company | string | Компания. |
| sector | string | Сектор. |
| country_of_risk | string | Код страны риска. |
| country_of_risk_name | string | Наименование страны риска. |
AssetInstrument
Идентификаторы инструмента.
| Field | Type | Description |
|---|---|---|
| uid | string | UID-идентификатор инструмента. |
| figi | string | FIGI-идентификатор инструмента. |
| instrument_type | string | Тип инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код (секция торгов). |
| links | Массив объектов InstrumentLink | Массив связанных инструментов. |
| instrument_kind | InstrumentType | Тип инструмента. |
| position_uid | string | ID позиции. |
InstrumentLink
Связь с другим инструментом.
| Field | Type | Description |
|---|---|---|
| type | string | Тип связи. |
| instrument_uid | string | UID-идентификатор связанного инструмента. |
GetFavoritesRequest
Запрос списка избранных инструментов, входные параметры не требуются.
GetFavoritesResponse
В ответ передается список избранных инструментов в качестве массива.
| Field | Type | Description |
|---|---|---|
| favorite_instruments | Массив объектов FavoriteInstrument | Массив инструментов. |
FavoriteInstrument
Массив избранных инструментов.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код инструмента. |
| isin | string | ISIN-идентификатор инструмента. |
| instrument_type | string | Тип инструмента. |
| name | string | Название инструмента. |
| uid | string | Уникальный идентификатор инструмента. |
| otc_flag | bool | Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке. |
| api_trade_available_flag | bool | Возможность торговать инструментом через API. |
| instrument_kind | InstrumentType | Тип инструмента. |
EditFavoritesRequest
Запрос редактирования списка избранных инструментов.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов EditFavoritesRequestInstrument | Массив инструментов. |
| action_type | EditFavoritesActionType | Тип действия со списком. |
EditFavoritesRequestInstrument
Массив инструментов для редактирования списка избранных инструментов.
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| instrument_id | string | Идентификатор инструмента — figi или instrument_uid. |
EditFavoritesResponse
Результат редактирования списка избранных инструментов.
| Field | Type | Description |
|---|---|---|
| favorite_instruments | Массив объектов FavoriteInstrument | Массив инструментов. |
GetCountriesRequest
Запрос справочника стран.
GetCountriesResponse
Справочник стран.
| Field | Type | Description |
|---|---|---|
| countries | Массив объектов CountryResponse | Массив стран. |
IndicativesRequest
Запрос справочника индексов и товаров
IndicativesResponse
Справочник индексов и товаров
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов IndicativeResponse | Массив инструментов. |
IndicativeResponse
Индикатив
| Field | Type | Description |
|---|---|---|
| figi | string | FIGI-идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| class_code | string | Класс-код инструмента. |
| currency | string | Валюта расчетов. |
| instrument_kind | InstrumentType | Тип инструмента. |
| name | string | Название инструмента. |
| exchange | string | Tорговая площадка (секция биржи). |
| uid | string | Уникальный идентификатор инструмента. |
| buy_available_flag | bool | Признак доступности для покупки. |
| sell_available_flag | bool | Признак доступности для продажи. |
CountryResponse
Данные о стране.
| Field | Type | Description |
|---|---|---|
| alfa_two | string | Двухбуквенный код страны. |
| alfa_three | string | Трехбуквенный код страны. |
| name | string | Наименование страны. |
| name_brief | string | Краткое наименование страны. |
FindInstrumentRequest
Запрос на поиск инструментов.
| Field | Type | Description |
|---|---|---|
| query | string | Строка поиска. |
| instrument_kind | InstrumentType | Фильтр по типу инструмента. |
| api_trade_available_flag | bool | Фильтр для отображения только торговых инструментов. |
FindInstrumentResponse
Результат поиска инструментов.
| Field | Type | Description |
|---|---|---|
| instruments | Массив объектов InstrumentShort | Массив инструментов, удовлетворяющих условиям поиска. |
InstrumentShort
Краткая информация об инструменте.
| Field | Type | Description |
|---|---|---|
| isin | string | ISIN инструмента. |
| figi | string | FIGI инструмента. |
| ticker | string | Ticker инструмента. |
| class_code | string | ClassCode инструмента. |
| instrument_type | string | Тип инструмента. |
| name | string | Название инструмента. |
| uid | string | Уникальный идентификатор инструмента. |
| position_uid | string | Уникальный идентификатор позиции инструмента. |
| instrument_kind | InstrumentType | Тип инструмента. |
| api_trade_available_flag | bool | Возможность торговать инструментом через API. |
| for_iis_flag | bool | Признак доступности для ИИС. |
| first_1min_candle_date | google.protobuf.Timestamp | Дата первой минутной свечи. |
| first_1day_candle_date | google.protobuf.Timestamp | Дата первой дневной свечи. |
| for_qual_investor_flag | bool | Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов. |
| weekend_flag | bool | Флаг, отображающий доступность торговли инструментом по выходным. |
| blocked_tca_flag | bool | Флаг заблокированного ТКС. |
| lot | int32 | Количество бумаг в лоте. |
GetBrandsRequest
Запрос списка брендов.
| Field | Type | Description |
|---|---|---|
| paging | Page | Настройки пагинации. |
GetBrandRequest
Запрос бренда.
| Field | Type | Description |
|---|---|---|
| id | string | UID-идентификатор бренда. |
GetBrandsResponse
Список брендов.
| Field | Type | Description |
|---|---|---|
| brands | Массив объектов Brand | Массив брендов. |
| paging | PageResponse | Данные по пагинации. |
GetAssetFundamentalsRequest
Запрос фундаментальных показателей
| Field | Type | Description |
|---|---|---|
| assets | Массив объектов string | Массив идентификаторов активов, не более 100 шт. |
GetAssetFundamentalsResponse
Фундаментальные показатели
| Field | Type | Description |
|---|---|---|
| fundamentals | Массив объектов GetAssetFundamentalsResponse.StatisticResponse |
GetAssetFundamentalsResponse.StatisticResponse
Фундаментальные показатели по активу
| Field | Type | Description |
|---|---|---|
| asset_uid | string | Идентификатор актива. |
| currency | string | Валюта. |
| market_capitalization | double | Рыночная капитализация. |
| high_price_last_52_weeks | double | Максимум за год. |
| low_price_last_52_weeks | double | Минимум за год. |
| average_daily_volume_last_10_days | double | Средний объем торгов за 10 дней. |
| average_daily_volume_last_4_weeks | double | Средний объем торгов за месяц. |
| beta | double | |
| free_float | double | Доля акций в свободном обращении. |
| forward_annual_dividend_yield | double | Процент форвардной дивидендной доходности по отношению к цене акций. |
| shares_outstanding | double | Количество акций в обращении. |
| revenue_ttm | double | Выручка. |
| ebitda_ttm | double | EBITDA — прибыль до вычета процентов, налогов, износа и амортизации. |
| net_income_ttm | double | Чистая прибыль. |
| eps_ttm | double | EPS — величина чистой прибыли компании, которая приходится на каждую обыкновенную акцию. |
| diluted_eps_ttm | double | EPS компании с допущением, что все конвертируемые ценные бумаги компании были сконвертированы в обыкновенные акции. |
| free_cash_flow_ttm | double | Свободный денежный поток. |
| five_year_annual_revenue_growth_rate | double | Среднегодовой рocт выручки за 5 лет. |
| three_year_annual_revenue_growth_rate | double | Среднегодовой рocт выручки за 3 года. |
| pe_ratio_ttm | double | Соотношение рыночной капитализации компании к ее чистой прибыли. |
| price_to_sales_ttm | double | Соотношение рыночной капитализации компании к ее выручке. |
| price_to_book_ttm | double | Соотношение рыночной капитализации компании к ее балансовой стоимости. |
| price_to_free_cash_flow_ttm | double | Соотношение рыночной капитализации компании к ее свободному денежному потоку. |
| total_enterprise_value_mrq | double | Рыночная стоимость компании. |
| ev_to_ebitda_mrq | double | Соотношение EV и EBITDA. |
| net_margin_mrq | double | Маржа чистой прибыли. |
| net_interest_margin_mrq | double | Рентабельность чистой прибыли. |
| roe | double | Рентабельность собственного капитала. |
| roa | double | Рентабельность активов. |
| roic | double | Рентабельность активов. |
| total_debt_mrq | double | Сумма краткосрочных и долгосрочных обязательств компании. |
| total_debt_to_equity_mrq | double | Соотношение долга к собственному капиталу. |
| total_debt_to_ebitda_mrq | double | Total Debt/EBITDA. |
| free_cash_flow_to_price | double | Отношение свободногоо кэша к стоимости. |
| net_debt_to_ebitda | double | Отношение чистого долга к EBITDA. |
| current_ratio_mrq | double | Коэффициент текущей ликвидности. |
| fixed_charge_coverage_ratio_fy | double | Коэффициент покрытия фиксированных платежей — FCCR. |
| dividend_yield_daily_ttm | double | Дивидендная доходность за 12 месяцев. |
| dividend_rate_ttm | double | Выплаченные дивиденды за 12 месяцев. |
| dividends_per_share | double | Значение дивидендов на акцию. |
| five_years_average_dividend_yield | double | Средняя дивидендная доходность за 5 лет. |
| five_year_annual_dividend_growth_rate | double | Среднегодовой рост дивидендов за 5 лет. |
| dividend_payout_ratio_fy | double | Процент чистой прибыли, уходящий на выплату дивидендов. |
| buy_back_ttm | double | Деньги, потраченные на обратный выкуп акций. |
| one_year_annual_revenue_growth_rate | double | Рост выручки за 1 год. |
| domicile_indicator_code | string | Код страны. |
| adr_to_common_share_ratio | double | Соотношение депозитарной расписки к акциям. |
| number_of_employees | double | Количество сотрудников. |
| ex_dividend_date | google.protobuf.Timestamp | |
| fiscal_period_start_date | google.protobuf.Timestamp | Начало фискального периода. |
| fiscal_period_end_date | google.protobuf.Timestamp | Окончание фискального периода. |
| revenue_change_five_years | double | Изменение общего дохода за 5 лет. |
| eps_change_five_years | double | Изменение EPS за 5 лет. |
| ebitda_change_five_years | double | Изменение EBIDTA за 5 лет. |
| total_debt_change_five_years | double | Изменение общей задолжности за 5 лет. |
| ev_to_sales | double | Отношение EV к выручке. |
GetAssetReportsRequest
Запрос отчетов эмитентов
| Field | Type | Description |
|---|---|---|
| instrument_id | string | Идентификатор инструмента в формате UID. |
| from | google.protobuf.Timestamp | Начало запрашиваемого периода по UTC. |
| to | google.protobuf.Timestamp | Окончание запрашиваемого периода по UTC. |
GetAssetReportsResponse
Отчеты эмитентов
| Field | Type | Description |
|---|---|---|
| events | Массив объектов GetAssetReportsResponse.GetAssetReportsEvent | Массив событий по облигации. |
GetAssetReportsResponse.GetAssetReportsEvent
Отчет
| Field | Type | Description |
|---|---|---|
| instrument_id | string | Идентификатор инструмента. |
| report_date | google.protobuf.Timestamp | Дата публикации отчета. |
| period_year | int32 | Год периода отчета. |
| period_num | int32 | Номер периода. |
| period_type | GetAssetReportsResponse.AssetReportPeriodType | Тип отчета. |
| created_at | google.protobuf.Timestamp | Дата создания записи. |
GetConsensusForecastsRequest
Запрос консенсус-прогнозов
| Field | Type | Description |
|---|---|---|
| paging | Page | Настройки пагинации. |
GetConsensusForecastsResponse
Консенсус-прогнозы
| Field | Type | Description |
|---|---|---|
| items | Массив объектов GetConsensusForecastsResponse.ConsensusForecastsItem | Массив прогнозов. |
| page | PageResponse | Данные по пагинации. |
GetConsensusForecastsResponse.ConsensusForecastsItem
Прогноз
| Field | Type | Description |
|---|---|---|
| uid | string | UID-идентификатор. |
| asset_uid | string | UID-идентификатор актива. |
| created_at | google.protobuf.Timestamp | Дата и время создания записи. |
| best_target_price | Quotation | Целевая цена на 12 месяцев. |
| best_target_low | Quotation | Минимальная прогнозная цена. |
| best_target_high | Quotation | Максимальная прогнозная цена. |
| total_buy_recommend | int32 | Количество аналитиков рекомендующих покупать. |
| total_hold_recommend | int32 | Количество аналитиков рекомендующих держать. |
| total_sell_recommend | int32 | Количество аналитиков рекомендующих продавать. |
| currency | string | Валюта прогнозов инструмента. |
| consensus | Recommendation | Консенсус-прогноз. |
| prognosis_date | google.protobuf.Timestamp | Дата прогноза. |
GetForecastRequest
Запрос прогнозов инвестдомов.
| Field | Type | Description |
|---|---|---|
| instrument_id | string | Идентификатор инструмента. |
GetForecastResponse
Прогнозы инвестдомов по инструменту.
| Field | Type | Description |
|---|---|---|
| targets | Массив объектов GetForecastResponse.TargetItem | Массив прогнозов. |
| consensus | GetForecastResponse.ConsensusItem | Согласованный прогноз. |
GetForecastResponse.TargetItem
Прогноз
| Field | Type | Description |
|---|---|---|
| uid | string | Уникальный идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| company | string | Название компании, давшей прогноз. |
| recommendation | Recommendation | Прогноз. |
| recommendation_date | google.protobuf.Timestamp | Дата прогноза. |
| currency | string | Валюта. |
| current_price | Quotation | Текущая цена. |
| target_price | Quotation | Прогнозируемая цена. |
| price_change | Quotation | Изменение цены. |
| price_change_rel | Quotation | Относительное изменение цены. |
| show_name | string | Наименование инструмента. |
GetForecastResponse.ConsensusItem
Консенсус-прогноз.
| Field | Type | Description |
|---|---|---|
| uid | string | Уникальный идентификатор инструмента. |
| ticker | string | Тикер инструмента. |
| recommendation | Recommendation | Прогноз. |
| currency | string | Валюта. |
| current_price | Quotation | Текущая цена. |
| consensus | Quotation | Прогнозируемая цена. |
| min_target | Quotation | Минимальная цена прогноза. |
| max_target | Quotation | Максимальная цена прогноза. |
| price_change | Quotation | Изменение цены. |
| price_change_rel | Quotation | Относительное изменение цены. |
TradingInterval
| Field | Type | Description |
|---|---|---|
| type | string | Название интервала. |
| interval | TradingInterval.TimeInterval | Интервал. |
TradingInterval.TimeInterval
| Field | Type | Description |
|---|---|---|
| start_ts | google.protobuf.Timestamp | Время начала интервала. |
| end_ts | google.protobuf.Timestamp | Время окончания интервала. |
Enums
CouponType
Тип купонов.
| Name | Number | Description |
|---|---|---|
| COUPON_TYPE_UNSPECIFIED | 0 | Неопределенное значение. |
| COUPON_TYPE_CONSTANT | 1 | Постоянный. |
| COUPON_TYPE_FLOATING | 2 | Плавающий. |
| COUPON_TYPE_DISCOUNT | 3 | Дисконт. |
| COUPON_TYPE_MORTGAGE | 4 | Ипотечный. |
| COUPON_TYPE_FIX | 5 | Фиксированный. |
| COUPON_TYPE_VARIABLE | 6 | Переменный. |
| COUPON_TYPE_OTHER | 7 | Прочее. |
OptionDirection
Тип опциона по направлению сделки.
| Name | Number | Description |
|---|---|---|
| OPTION_DIRECTION_UNSPECIFIED | 0 | Тип не определен. |
| OPTION_DIRECTION_PUT | 1 | Опцион на продажу. |
| OPTION_DIRECTION_CALL | 2 | Опцион на покупку. |
OptionPaymentType
Тип расчетов по опциону.
| Name | Number | Description |
|---|---|---|
| OPTION_PAYMENT_TYPE_UNSPECIFIED | 0 | Тип не определен. |
| OPTION_PAYMENT_TYPE_PREMIUM | 1 | Опционы с использованием премии в расчетах. |
| OPTION_PAYMENT_TYPE_MARGINAL | 2 | Маржируемые опционы. |
OptionStyle
Тип опциона по стилю.
| Name | Number | Description |
|---|---|---|
| OPTION_STYLE_UNSPECIFIED | 0 | Тип не определен. |
| OPTION_STYLE_AMERICAN | 1 | Американский опцион. |
| OPTION_STYLE_EUROPEAN | 2 | Европейский опцион. |
OptionSettlementType
Тип опциона по способу исполнения.
| Name | Number | Description |
|---|---|---|
| OPTION_EXECUTION_TYPE_UNSPECIFIED | 0 | Тип не определен. |
| OPTION_EXECUTION_TYPE_PHYSICAL_DELIVERY | 1 | Поставочный тип опциона. |
| OPTION_EXECUTION_TYPE_CASH_SETTLEMENT | 2 | Расчетный тип опциона. |
InstrumentIdType
Тип идентификатора инструмента. Подробнее об идентификации инструментов.
| Name | Number | Description |
|---|---|---|
| INSTRUMENT_ID_UNSPECIFIED | 0 | Значение не определено. |
| INSTRUMENT_ID_TYPE_FIGI | 1 | FIGI. |
| INSTRUMENT_ID_TYPE_TICKER | 2 | Ticker. |
| INSTRUMENT_ID_TYPE_UID | 3 | Уникальный идентификатор. |
| INSTRUMENT_ID_TYPE_POSITION_UID | 4 | Идентификатор позиции. |
ShareType
Тип акций.
| Name | Number | Description |
|---|---|---|
| SHARE_TYPE_UNSPECIFIED | 0 | Значение не определено. |
| SHARE_TYPE_COMMON | 1 | Обыкновенная. |
| SHARE_TYPE_PREFERRED | 2 | Привилегированная. |
| SHARE_TYPE_ADR | 3 | Американские депозитарные расписки. |
| SHARE_TYPE_GDR | 4 | Глобальные депозитарные расписки. |
| SHARE_TYPE_MLP | 5 | Товарищество с ограниченной ответственностью. |
| SHARE_TYPE_NY_REG_SHRS | 6 | Акции из реестра Нью-Йорка. |
| SHARE_TYPE_CLOSED_END_FUND | 7 | Закрытый инвестиционный фонд. |
| SHARE_TYPE_REIT | 8 | Траст недвижимости. |
AssetType
Тип актива.
| Name | Number | Description |
|---|---|---|
| ASSET_TYPE_UNSPECIFIED | 0 | Тип не определен. |
| ASSET_TYPE_CURRENCY | 1 | Валюта. |
| ASSET_TYPE_COMMODITY | 2 | Товар. |
| ASSET_TYPE_INDEX | 3 | Индекс. |
| ASSET_TYPE_SECURITY | 4 | Ценная бумага. |
StructuredProductType
Тип структурной ноты.
| Name | Number | Description |
|---|---|---|
| SP_TYPE_UNSPECIFIED | 0 | Тип не определен. |
| SP_TYPE_DELIVERABLE | 1 | Поставочный. |
| SP_TYPE_NON_DELIVERABLE | 2 | Беспоставочный. |
EditFavoritesActionType
Тип действия со списком избранных инструментов.
| Name | Number | Description |
|---|---|---|
| EDIT_FAVORITES_ACTION_TYPE_UNSPECIFIED | 0 | Тип не определен. |
| EDIT_FAVORITES_ACTION_TYPE_ADD | 1 | Добавить в список. |
| EDIT_FAVORITES_ACTION_TYPE_DEL | 2 | Удалить из списка. |
RealExchange
Реальная площадка исполнения расчетов.
| Name | Number | Description |
|---|---|---|
| REAL_EXCHANGE_UNSPECIFIED | 0 | Тип не определен. |
| REAL_EXCHANGE_MOEX | 1 | Московская биржа. |
| REAL_EXCHANGE_RTS | 2 | Санкт-Петербургская биржа. |
| REAL_EXCHANGE_OTC | 3 | Внебиржевой инструмент. |
| REAL_EXCHANGE_DEALER | 4 | Инструмент, торгуемый на площадке брокера. |
Recommendation
| Name | Number | Description |
|---|---|---|
| RECOMMENDATION_UNSPECIFIED | 0 | Не определено. |
| RECOMMENDATION_BUY | 1 | Покупать. |
| RECOMMENDATION_HOLD | 2 | Держать. |
| RECOMMENDATION_SELL | 3 | Продавать. |
RiskLevel
Уровень риска облигации.
| Name | Number | Description |
|---|---|---|
| RISK_LEVEL_UNSPECIFIED | 0 | Не указан. |
| RISK_LEVEL_LOW | 1 | Низкий уровень риска. |
| RISK_LEVEL_MODERATE | 2 | Средний уровень риска. |
| RISK_LEVEL_HIGH | 3 | Высокий уровень риска. |
BondType
| Name | Number | Description |
|---|---|---|
| BOND_TYPE_UNSPECIFIED | 0 | Тип облигации не определен. |
| BOND_TYPE_REPLACED | 1 | Замещающая облигация. |
InstrumentExchangeType
Площадка торговли.
| Name | Number | Description |
|---|---|---|
| INSTRUMENT_EXCHANGE_UNSPECIFIED | 0 | Площадка торговли не определена. |
| INSTRUMENT_EXCHANGE_DEALER | 1 | Бумага, торгуемая у дилера. |
GetBondEventsRequest.EventType
| Name | Number | Description |
|---|---|---|
| EVENT_TYPE_UNSPECIFIED | 0 | Неопределенное значение. |
| EVENT_TYPE_CPN | 1 | Купон. |
| EVENT_TYPE_CALL | 2 | Опцион (оферта). |
| EVENT_TYPE_MTY | 3 | Погашение. |
| EVENT_TYPE_CONV | 4 | Конвертация. |
GetAssetReportsResponse.AssetReportPeriodType
| Name | Number | Description |
|---|---|---|
| PERIOD_TYPE_UNSPECIFIED | 0 | Не указан. |
| PERIOD_TYPE_QUARTER | 1 | Квартальный. |
| PERIOD_TYPE_SEMIANNUAL | 2 | Полугодовой. |
| PERIOD_TYPE_ANNUAL | 3 | Годовой. |
InstrumentType
| Name | Number | Description |
|---|---|---|
| INSTRUMENT_TYPE_UNSPECIFIED | 0 | Тип инструмента не определен |
| INSTRUMENT_TYPE_BOND | 1 | Облигация |
| INSTRUMENT_TYPE_SHARE | 2 | Акция |
| INSTRUMENT_TYPE_CURRENCY | 3 | Валюта |
| INSTRUMENT_TYPE_ETF | 4 | Exchange-traded fund |
| INSTRUMENT_TYPE_FUTURES | 5 | Фьючерс |
| INSTRUMENT_TYPE_SP | 6 | Структурная нота |
| INSTRUMENT_TYPE_OPTION | 7 | Опцион |
| INSTRUMENT_TYPE_CLEARING_CERTIFICATE | 8 | Clearing certificate |
| INSTRUMENT_TYPE_INDEX | 9 | Индекс |
| INSTRUMENT_TYPE_COMMODITY | 10 | Товар |
InstrumentStatus
Статус запрашиваемых инструментов.
| Name | Number | Description |
|---|---|---|
| INSTRUMENT_STATUS_UNSPECIFIED | 0 | Значение не определено. |
| INSTRUMENT_STATUS_BASE | 1 | По умолчанию — базовый список инструментов, которыми можно торговать через T-Invest API. Сейчас списки доступных бумаг в API и других интерфейсах совпадают — кроме внебиржевых бумаг, но в будущем списки могут различаться. |
| INSTRUMENT_STATUS_ALL | 2 | Список всех инструментов. |
Execution
| Value | Description |
|---|---|
| ED | Execution after Default - платеж выполнен после дефолта (должна быть дата платежа) |
| ET | Выполнены обязательства по техническому дефолту (платеж выполнен после дефолта) |
| ES | Выполнены обязательства по соглашению (платеж выполнен после соглашения) |
| S | Соглашение |
| T | Технический дефолт |
| E | Execution - исполнено, платеж выполнен без задержек |
| D | Default - дефолт |
| TD | Технически дефолт - задержка платежа более 5 дней, но менее 20 |
OperationType
| EventType | Value | Description |
|---|---|---|
| CPN | Одно из значений: Прочий, Переменный, Фиксированный, Ипотечный, Дисконт, Плавающий, Постоянный | |
| MTY | CA | Эмитент реализовал Call-опцион / частичное (амортизационное) погашение |
| MTY | OA | Call-опциона нет или не реализован / частичное (амортизационное) погашение |
| MTY | CM | Полное погашение оставшегося номинала, OM - полное погашение оставшегося номинала |
| MTY | CA | Эмитент реализовал Call-опцион / частичное (амортизационное) погашение |
| CALL | M | Досрочное погашение облигаций по праву эмитента |
| CALL | N | Досрочное погашение облигаций по требованию владельцев |
| CALL | C | Call-опцион |
| CALL | L | Call опцион на период |
| CALL | O | Оферта с возможностью дальнейшего обращения облигаций по требованию владельцев |
| CALL | K | Выкуп РЕПО |
| CALL | A | Досрочный выкуп облигаций по соглашению с их владельцами |
| CALL | V | Досрочное погашение ковенант |
| CONV | пусто | Не применимо |
Нестандартные типы данных
MoneyValue
Денежная сумма в определенной валюте
| Field | Type | Description |
|---|---|---|
| currency | string | Строковый ISO-код валюты |
| units | int64 | Целая часть суммы, может быть отрицательным числом |
| nano | int32 | Дробная часть суммы, может быть отрицательным числом |
Quotation
Котировка - денежная сумма без указания валюты
| Field | Type | Description |
|---|---|---|
| units | int64 | Целая часть суммы, может быть отрицательным числом |
| nano | int32 | Дробная часть суммы, может быть отрицательным числом |
BrandData
Данные о бренде
| Field | Type | Description |
|---|---|---|
| logo_name | string | Логотип инструмента. Имя файла для получения логотипа |
| logo_base_color | string | Цвет бренда |
| text_color | string | Цвет текста для цвета логотипа бренда |