Методы
InstrumentsService
Сервис предназначен для получения:1. информации об инструментах;2. расписания торговых сессий;3. календаря выплат купонов по облигациям;4. размера гарантийного обеспечения по фьючерсам;5. дивидендов по ценной бумаге.
Методы сервиса
TradingSchedules
Метод получения расписания торгов торговых площадок.
-
Тело запроса — TradingSchedulesRequest
-
Тело ответа — TradingSchedulesResponse
BondBy
Метод получения облигации по её идентификатору.
-
Тело запроса — InstrumentRequest
-
Тело ответа — BondResponse
Bonds
Метод получения списка облигаций.
-
Тело запроса — InstrumentsRequest
-
Тело ответа — BondsResponse
GetBondCoupons
Метод получения графика выплат купонов по облигации.
-
Тело запроса — GetBondCouponsRequest
-
Тело ответа — GetBondCouponsResponse
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
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
Сообщения методов
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. |
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 | Статус запрашиваемых инструментов. Возможные значения: InstrumentStatus |
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 (дата выплаты купона) |
GetBondCouponsResponse
Купоны по облигации.
Field | Type | Description |
---|---|---|
events | Массив объектов Coupon | |
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 | Реальная площадка исполнения расчётов (биржа). Допустимые значения: [REAL_EXCHANGE_MOEX, REAL_EXCHANGE_RTS] |
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 | Сектор экономики. |
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 | Цена страйка. |
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 | Признак внебиржевой ценной бумаги. |
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 | Признак внебиржевой ценной бумаги. |
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 | Уникальный идентификатор позиции инструмента. |
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 | Уровень риска. |
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 | Признак внебиржевой ценной бумаги. |
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 | Реальная площадка исполнения расчётов (биржа). |
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 | Дата первой дневной свечи. |
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 | Признак внебиржевой ценной бумаги. |
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 | Уникальный идентификатор позиции инструмента. |
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 | Дата первой дневной свечи. |
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 | Признак внебиржевой ценной бумаги. |
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 | Дата первой дневной свечи. |
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 | Признак внебиржевой ценной бумаги. |
buy_available_flag | bool | Признак доступности для покупки. |
sell_available_flag | bool | Признак доступности для продажи. |
div_yield_flag | bool | Признак наличия дивидендной доходности. |
share_type | ShareType | Тип акции. Возможные значения: ShareType |
min_price_increment | Quotation | Шаг цены. |
api_trade_available_flag | bool | Параметр указывает на возможность торговать инструментом через API. |
uid | string | Уникальный идентификатор инструмента. |
real_exchange | RealExchange | Реальная площадка исполнения расчётов (биржа). |
position_uid | string | Уникальный идентификатор позиции инструмента. |
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 | Дата первой дневной свечи. |
GetAccruedInterestsRequest
Запрос НКД по облигации
Field | Type | Description |
---|---|---|
figi | string | Figi-идентификатор инструмента. |
from | google.protobuf.Timestamp | Начало запрашиваемого периода в часовом поясе UTC. |
to | google.protobuf.Timestamp | Окончание запрашиваемого периода в часовом поясе UTC. |
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 | Идентификатор инструмента. |
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 | Признак внебиржевой ценной бумаги. |
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 | Уникальный идентификатор позиции инструмента. |
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 | Дата первой дневной свечи. |
GetDividendsRequest
Запрос дивидендов.
Field | Type | Description |
---|---|---|
figi | string | Figi-идентификатор инструмента. |
from | google.protobuf.Timestamp | Начало запрашиваемого периода в часовом поясе UTC. Фильтрация происходит по параметру record_date (дата фиксации реестра). |
to | google.protobuf.Timestamp | Окончание запрашиваемого периода в часовом поясе UTC. Фильтрация происходит по параметру record_date (дата фиксации реестра). |
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 | |
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 | Тип инструмента. |
otc_flag | bool | Признак внебиржевой ценной бумаги. |
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-идентификатор инструмента. |
EditFavoritesResponse
Результат редактирования списка избранных инструментов.
Field | Type | Description |
---|---|---|
favorite_instruments | Массив объектов FavoriteInstrument | Массив инструментов |
GetCountriesRequest
Запрос справочника стран.
GetCountriesResponse
Справочник стран.
Field | Type | Description |
---|---|---|
countries | Массив объектов CountryResponse | Массив стран. |
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 | Флаг заблокированного ТКС |
GetBrandsRequest
Запрос списка брендов.
GetBrandRequest
Запрос бренда.
Field | Type | Description |
---|---|---|
id | string | Uid-идентификатор бренда. |
GetBrandsResponse
Список брендов.
Field | Type | Description |
---|---|---|
brands | Массив объектов Brand | Массив брендов. |
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 | Идентификатор позиции. |
InstrumentStatus
Статус запрашиваемых инструментов.
Name | Number | Description |
---|---|---|
INSTRUMENT_STATUS_UNSPECIFIED | 0 | Значение не определено. |
INSTRUMENT_STATUS_BASE | 1 | Базовый список инструментов (по умолчанию). Инструменты доступные для торговли через TINKOFF INVEST API. Cейчас списки бумаг, доступных из api и других интерфейсах совпадают (за исключением внебиржевых бумаг), но в будущем возможны ситуации, когда списки инструментов будут отличаться |
INSTRUMENT_STATUS_ALL | 2 | Список всех инструментов. |
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 | Внебиржевой инструмент. |
RiskLevel
Уровень риска облигации.
Name | Number | Description |
---|---|---|
RISK_LEVEL_HIGH | 0 | Высокий уровень риска |
RISK_LEVEL_MODERATE | 1 | Средний уровень риска |
RISK_LEVEL_LOW | 2 | Низкий уровень риска |
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 | Дробная часть суммы, может быть отрицательным числом |