gRPC-методы
С помощью методов сервиса можно получить:
- список счетов пользователя;
- маржинальные показатели по счету.
Протестировать и отправить запросы можно через REST-методы.
Методы сервиса
GetAccounts
Счета пользователя.
Тело запроса — GetAccountsRequest
Тело ответа — GetAccountsResponse
GetMarginAttributes
Маржинальные показатели по счету. Метод позволяет получить маржинальные показатели и ликвидность по заданному счeту.
Тело запроса — GetMarginAttributesRequest
Тело ответа — GetMarginAttributesResponse
GetUserTariff
Тариф пользователя.
Тело запроса — GetUserTariffRequest
Тело ответа — GetUserTariffResponse
GetInfo
Информация о пользователе.
Тело запроса — GetInfoRequest
Тело ответа — GetInfoResponse
GetBankAccounts
GetBankAccounts — банковские счета пользователя. Получить список счетов пользователя, в том числе и банковских.
Тело запроса — GetBankAccountsRequest
Тело ответа — GetBankAccountsResponse
CurrencyTransfer
CurrencyTransfer — перевод денежных средств между счетами. Перевести денежные средства между брокерскими счетами.
Тело запроса — CurrencyTransferRequest
Тело ответа — CurrencyTransferResponse
Сообщения методов
GetAccountsRequest
Запрос получения счетов пользователя.
| Field | Type | Description |
|---|---|---|
| status | AccountStatus | Статус счета. |
GetAccountsResponse
Список счетов пользователя.
| Field | Type | Description |
|---|---|---|
| accounts | Массив объектов Account | Массив счетов клиента. |
Account
Информация о счете.
| Field | Type | Description |
|---|---|---|
| id | string | Идентификатор счета. |
| type | AccountType | Тип счета. |
| name | string | Название счета. |
| status | AccountStatus | Статус счета. |
| opened_date | google.protobuf.Timestamp | Дата открытия счета в часовом поясе UTC. |
| closed_date | google.protobuf.Timestamp | Дата закрытия счета в часовом поясе UTC. |
| access_level | AccessLevel | Уровень доступа к текущему счету (определяется токеном). |
GetMarginAttributesRequest
Запрос маржинальных показателей по счету.
| Field | Type | Description |
|---|---|---|
| account_id | string | Идентификатор счета пользователя. |
GetMarginAttributesResponse
Маржинальные показатели по счету.
| Field | Type | Description |
|---|---|---|
| liquid_portfolio | MoneyValue | Ликвидная стоимость портфеля. Подробнее про ликвидный портфель. |
| starting_margin | MoneyValue | Начальная маржа — начальное обеспечение для совершения новой сделки. Подробнее про начальную и минимальную маржу. |
| minimal_margin | MoneyValue | Минимальная маржа — это минимальное обеспечение для поддержания позиции, которую вы уже открыли. Подробнее про начальную и минимальную маржу. |
| funds_sufficiency_level | Quotation | Уровень достаточности средств. Соотношение стоимости ликвидного портфеля к начальной марже. |
| amount_of_missing_funds | MoneyValue | Объем недостающих средств. Разница между стартовой маржой и ликвидной стоимости портфеля. |
| corrected_margin | MoneyValue | Скорректированная маржа. Начальная маржа, в которой плановые позиции рассчитываются с учетом активных заявок на покупку позиций лонг или продажу позиций шорт. |
GetUserTariffRequest
Запрос текущих лимитов пользователя.
GetUserTariffResponse
Текущие лимиты пользователя.
| Field | Type | Description |
|---|---|---|
| unary_limits | Массив объектов UnaryLimit | Массив лимитов пользователя по unary-запросам. |
| stream_limits | Массив объектов StreamLimit | Массив лимитов пользователей для stream-соединений. |
UnaryLimit
Лимит unary-методов.
| Field | Type | Description |
|---|---|---|
| limit_per_minute | int32 | Количество unary-запросов в минуту. |
| methods | Массив объектов string | Названия методов. |
| limit_per_second | int32 | Количество unary-запросов в секунду. |
StreamLimit
Лимит stream-соединений.
| Field | Type | Description |
|---|---|---|
| limit | int32 | Максимальное количество stream-соединений. |
| streams | Массив объектов string | Названия stream-методов. |
| open | int32 | Текущее количество открытых stream-соединений. |
GetInfoRequest
Запрос информации о пользователе.
GetInfoResponse
Информация о пользователе.
| Field | Type | Description |
|---|---|---|
| prem_status | bool | Признак премиум клиента. |
| qual_status | bool | Признак квалифицированного инвестора. |
| qualified_for_work_with | Массив объектов string | Набор требующих тестирования инструментов и возможностей, с которыми может работать пользователь. Подробнее. |
| tariff | string | Наименование тарифа пользователя. |
| user_id | string | Идентификатор пользователя. |
GetBankAccountsRequest
Запрос списка банковских счетов пользователя.
GetBankAccountsResponse
Список банковских счетов пользователя.
| Field | Type | Description |
|---|---|---|
| bank_accounts | Массив объектов BankAccount | Массив банковских счетов. |
BankAccount
Банковский счeт.
| Field | Type | Description |
|---|---|---|
| id | string | Идентификатор счeта. |
| name | string | Название счeта. |
| money | Массив объектов MoneyValue | Список валютных позиций на счeте. |
| opened_date | google.protobuf.Timestamp | Дата открытия счeта в часовом поясе UTC. |
| type | AccountType | Тип счeта. |
CurrencyTransferRequest
| Field | Type | Description |
|---|---|---|
| from_account_id | string | Номер счета списания. |
| to_account_id | string | Номер счета зачисления. |
| amount | MoneyValue | Сумма перевода с указанием валюты. |
| transaction_id | string | Идентификатор запроса выставления поручения для целей идемпотентности в формате UUID. |
CurrencyTransferResponse
Enums
AccountType
Тип счета.
| Name | Number | Description |
|---|---|---|
| ACCOUNT_TYPE_UNSPECIFIED | 0 | Тип аккаунта не определен. |
| ACCOUNT_TYPE_TINKOFF | 1 | Брокерский счет Т-Инвестиций. |
| ACCOUNT_TYPE_TINKOFF_IIS | 2 | ИИС. |
| ACCOUNT_TYPE_INVEST_BOX | 3 | Инвесткопилка. |
| ACCOUNT_TYPE_INVEST_FUND | 4 | Фонд денежного рынка. |
AccountStatus
Статус счета.
| Name | Number | Description |
|---|---|---|
| ACCOUNT_STATUS_UNSPECIFIED | 0 | Статус счета не определен. |
| ACCOUNT_STATUS_NEW | 1 | Новый, в процессе открытия. |
| ACCOUNT_STATUS_OPEN | 2 | Открытый и активный счет. |
| ACCOUNT_STATUS_CLOSED | 3 | Закрытый счет. |
| ACCOUNT_STATUS_ALL | 4 | Все счета. |
AccessLevel
Уровень доступа к счету.
| Name | Number | Description |
|---|---|---|
| ACCOUNT_ACCESS_LEVEL_UNSPECIFIED | 0 | Уровень доступа не определен. |
| ACCOUNT_ACCESS_LEVEL_FULL_ACCESS | 1 | Полный доступ к счету. |
| ACCOUNT_ACCESS_LEVEL_READ_ONLY | 2 | Доступ с уровнем прав «только чтение». |
| ACCOUNT_ACCESS_LEVEL_NO_ACCESS | 3 | Доступа нет. |
Нестандартные типы данных
MoneyValue
Денежная сумма в определенной валюте
| Field | Type | Description |
|---|---|---|
| currency | string | Строковый ISO-код валюты |
| units | int64 | Целая часть суммы, может быть отрицательным числом |
| nano | int32 | Дробная часть суммы, может быть отрицательным числом |
Quotation
Котировка — денежная сумма без указания валюты.
| Field | Type | Description |
|---|---|---|
| units | int64 | Целая часть суммы, может быть отрицательным числом |
| nano | int32 | Дробная часть суммы, может быть отрицательным числом |