yatis 0.2.1

Yet Another T-bank Investment Sdk
Documentation
# Глоссарий и дополнительная информация о методах сервиса инструментов

### Термины

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

В T-Invest API есть следующие виды активов:

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

Чтобы получить информацию об активах, используйте один из методов:

- [getAssets](/investAPI/instruments/#getassets), с помощью которого можно получить список всех активов. Активы, у которых есть связанные с ними инструменты, вернутся с массивом идентификаторов этих инструментов. Метод работает для всех инструментов, кроме срочных - опционов и фьючерсов.

    Возвращает краткую информацию об активе: 

    * Идентификатор.
    * Тип актива.
    * Название актива.
    * Массив инструментов актива.


- [getAssetBy](/investAPI/instruments/#getassetby), с помощью которого можно найти актив по его идентификатору.
Возвращает более подробную информацию о запрошенном активе.  

    Расширенное описание актива включает в себя детализированную информацию в зависимости от типа актива, информацию о бренде, владеющим данным активом, и связанные с активом инструменты.

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

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

>У каждой сущности есть уникальный идентификатор — UID. 

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

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

**Real_exchange** — реальная торговая площадка (биржа). Параметр возвращает значение биржи, на которой торгуется инструмент,
или значение `REAL_EXCHANGE_OTC` — оно указывает на то, что инструмент является внебиржевым.  

   Есть всего две реальные биржевые площадки — Мосбиржа и СПБ: `REAL_EXCHANGE_MOEX`, `REAL_EXCHANGE_RTS`.

### Опционы

[**Опционы**](https://www.tbank.ru/invest/help/educate/high-risk/about/derivatives/?card=q1#:~:text=%D0%B1%D1%83%D0%B4%D0%B5%D1%82%20%D0%B7%D0%B0%D0%BA%D1%80%D1%8B%D1%82%D0%B0%20%D0%BF%D1%80%D0%B8%D0%BD%D1%83%D0%B4%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D0%BE.-,%D0%BE%D0%BF%D1%86%D0%B8%D0%BE%D0%BD%D1%8B,-%D0%AD%D1%82%D0%BE%20%D0%BA%D0%BE%D0%BD%D1%82%D1%80%D0%B0%D0%BA%D1%82%D1%8B%2C%20%D0%BA%D0%BE%D1%82%D0%BE%D1%80%D1%8B%D0%B5) — это контракты, которые предусматривают право владельца опциона купить или продать базовый актив в указанный период и по определённой цене.

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

Для получения информации по опционам, страйкам и датам экспирации в T-Invest API есть следующие методы:

* [GetOptionBy](/investAPI/instruments/#optionby) — получить опцион по его идентификатору.
* [GetOptions](/investAPI/instruments/#options) — получить опционы.
- [getPositions](/investAPI/operations#getpositions) — получить массив опционов в портфеле.

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

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

1. В ответе метода [getAssets](/investAPI/instruments/#getassets) найдите нужный актив. Чтобы определить актив по его названию, используйте поле **name**.

2. Во входном параметре **basicAssetUid** метода [OptionsBy](/investAPI/instruments/#optionsby) передайте значение поля **uid** актива.

Метод [OptionsBy](/investAPI/instruments/#optionsby) возвращает все опционы базового актива с таким UID.