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

Термины

Актив (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 — получить опционы.
• getPositions — получить массив опционов в портфеле.

Также вы можете получить информацию о базовом активе опциона и найти его по идентификатору позиции базового инструмента — basicAssetPositionUid.

Чтобы найти опционы через их базовый актив:

1. В ответе метода getAssets найдите нужный актив. Чтобы определить актив по его названию, используйте поле name.

2. Во входном параметре basicAssetUid метода OptionsBy передайте значение поля uid актива.

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