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

Методы

InstrumentsService

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

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

TradingSchedules

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

BondBy

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

Bonds

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

GetBondCoupons

Метод получения графика выплат купонов по облигации

CurrencyBy

Метод получения валюты по её идентификатору.

Currencies

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

EtfBy

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

Etfs

Метод получения списка инвестиционных фондов.

FutureBy

Метод получения фьючерса по его идентификатору.

Futures

Метод получения списка фьючерсов.

ShareBy

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

Shares

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

GetAccruedInterests

Метод получения накопленного купонного дохода по облигации.

GetFuturesMargin

Метод получения размера гарантийного обеспечения по фьючерсам.

GetInstrumentBy

Метод получения основной информации об инструменте.

GetDividends

Метод для получения событий выплаты дивидендов по инструменту.

GetAssetBy

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

GetAssets

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

GetFavorites

Метод получения избранных инструментов.

EditFavorites

Метод редактирования избранных инструментов.

GetCountries

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

FindInstrument

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

GetBrands

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

GetBrandBy

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

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

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.

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

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 Массив фьючерсов.

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 Коэффициент ставки риска длинной позиции по инструменту.
kshort Quotation Коэффициент ставки риска короткой позиции по инструменту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций в шорт.
name string Название инструмента.
exchange string Торговая площадка.
coupon_quantity_per_year int32 Количество выплат по купонам в год.
maturity_date google.protobuf.Timestamp Дата погашения облигации в часовом поясе UTC.
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 Реальная площадка исполнения расчётов.

Currency

Объект передачи информации о валюте.

Field Type Description
figi string Figi-идентификатор инструмента.
ticker string Тикер инструмента.
class_code string Класс-код (секция торгов).
isin string Isin-идентификатор инструмента.
lot int32 Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее: лот
currency string Валюта расчётов.
klong Quotation Коэффициент ставки риска длинной позиции по инструменту.
kshort Quotation Коэффициент ставки риска короткой позиции по инструменту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций в шорт.
name string Название инструмента.
exchange string Торговая площадка.
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 Реальная площадка исполнения расчётов.

Etf

Объект передачи информации об инвестиционном фонде.

Field Type Description
figi string Figi-идентификатор инструмента.
ticker string Тикер инструмента.
class_code string Класс-код (секция торгов).
isin string Isin-идентификатор инструмента.
lot int32 Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее: лот
currency string Валюта расчётов.
klong Quotation Коэффициент ставки риска длинной позиции по инструменту.
kshort Quotation Коэффициент ставки риска короткой позиции по инструменту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций в шорт.
name string Название инструмента.
exchange string Торговая площадка.
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 Реальная площадка исполнения расчётов.

Future

Объект передачи информации о фьючерсе.

Field Type Description
figi string Figi-идентификатор инструмента.
ticker string Тикер инструмента.
class_code string Класс-код (секция торгов).
lot int32 Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее: лот
currency string Валюта расчётов.
klong Quotation Коэффициент ставки риска длинной позиции по клиенту.
kshort Quotation Коэффициент ставки риска короткой позиции по клиенту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций шорт.
name string Название инструмента.
exchange string Торговая площадка.
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 Реальная площадка исполнения расчётов.

Share

Объект передачи информации об акции.

Field Type Description
figi string Figi-идентификатор инструмента.
ticker string Тикер инструмента.
class_code string Класс-код (секция торгов).
isin string Isin-идентификатор инструмента.
lot int32 Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру lot. Подробнее: лот
currency string Валюта расчётов.
klong Quotation Коэффициент ставки риска длинной позиции по инструменту.
kshort Quotation Коэффициент ставки риска короткой позиции по инструменту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций в шорт.
name string Название инструмента.
exchange string Торговая площадка.
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 Реальная площадка исполнения расчётов.

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 Коэффициент ставки риска длинной позиции по инструменту.
kshort Quotation Коэффициент ставки риска короткой позиции по инструменту.
dlong Quotation Ставка риска минимальной маржи в лонг. Подробнее: ставка риска в лонг
dshort Quotation Ставка риска минимальной маржи в шорт. Подробнее: ставка риска в шорт
dlong_min Quotation Ставка риска начальной маржи в лонг. Подробнее: ставка риска в лонг
dshort_min Quotation Ставка риска начальной маржи в шорт. Подробнее: ставка риска в шорт
short_enabled_flag bool Признак доступности для операций в шорт.
name string Название инструмента.
exchange string Торговая площадка.
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 Реальная площадка исполнения расчётов.

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

Запрос списка активов.

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 Тип ценной бумаги.
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 Массив связанных инструментов.

Связь с другим инструментом.

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.

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 Строка поиска.

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 Уникальный идентификатор инструмента.

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 Прочее

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 Уникальный идентификатор.

InstrumentStatus

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

Name Number Description
INSTRUMENT_STATUS_UNSPECIFIED 0 Значение не определено.
INSTRUMENT_STATUS_BASE 1 Базовый список инструментов (по умолчанию). Инструменты доступные для торговли через TINKOFF INVEST 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 Внебиржевой инструмент.

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 Дробная часть суммы, может быть отрицательным числом