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

Глоссарий и дополнительная информация о методах сервиса инструментов

Наименование сущностей

Актив (asset) - ценная бумага. Сущность верхнего уровня может иметь несколько вложенных позиций (positions), а позиции содержат в свою очередь инструменты (instruments).

В TINKOFF INVEST API существуют следующие виды активов:

ASSET_TYPE_UNSPECIFIED – тип не определён;
ASSET_TYPE_CURRENCY – валюта;
ASSET_TYPE_COMMODITY – товар;
ASSET_TYPE_INDEX – индекс;
ASSET_TYPE_SECURITY – ценная бумага.

Для получения информации об активах вы можете использовать: - метод getAssets, с помощью которого можно получить список всех активов. Активы, имеющие связанные с ними инструменты, придут с массивом идентификаторов этих инструментов. Метод работает для всех инструментов, за исключением срочных - опционов и фьючерсов.

Данный метод возвращает краткую информацию об активе:

* Идентификатор
* Тип актива
* Название актива
* Массив инструментов актива
  • метод getAssetBy, с помощью которого можно найти актив по его идентификатору. Этот метод возвращает более подробную информацию о запрошенном активе.
    Расширенное описание актива включает в себя детализированную информацию в зависимости от типа актива, информацию о бренде, владеющим данным активом, и связанные с активом инструменты.

Позиция (position) - это совокупность актива и торговой площадки. Сущность второго уровня вложенности, содержит информацию о позициях.

Инструмент (instrument) - сущность третьего уровня, содержит информацию об инструментах. Инструменты изменяют позиции.

Каждая из сущностей имеет свой уникальный идентификатор uid.

Общие определения для параметров

Exchange - торговая площадка (секция биржи). В данном параметре возвращается наименование секции биржи, которое может быть использовано для получения информации о расписании торгов на данной секции.

Real_exchange - реальная торговая площадка (биржа). Данный параметр возвращает значение биржи, на которой торгуется инструмент. Или же значение REAL_EXCHANGE_OTC, указывающее на то, что инструмент является внебиржевым.
Есть всего две реальные биржевые площадки - Мосбиржа и СПБ (REAL_EXCHANGE_MOEX, REAL_EXCHANGE_RTS).

Опционы

Опционы - это контракты, которые предусматривают право владельца опциона купить или продать базовый актив в указанный период и по определенной цене.

Актив, в отношении которого заключается опцион, называется базовым активом. Например, им может выступать акция X. Опционы выступают финансовыми инструментами, связанными с конкретными активами.

В TINKOFF INVEST API добавлены методы:

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

С помощью данных методов можно получить информацию об опционах, страйках (strike_price) и датах экспирации. Так же можно получить информацию о базовом активе опциона, найти его по идентификатору позиции базового инструмента (basicAssetPositionUid).

Чтобы найти опционы через их базовый актив, вы должны:
1. В ответе метода getAssets найти необходимый вам актив. Вы можете использовать поле name для определения актива по его названию. 2. Передать значение поля uid необходимого актива во входной параметр basicAssetUid метода OptionsBy.

Метод OptionsBy вернет вам все опционы базового актива с таким uid.