Методы
UsersService
Сервис предназначен для получения: 1. списка счетов пользователя; 2. маржинальных показателей по счёту.
Методы сервиса
GetAccounts
Метод получения счетов пользователя.
-
Тело запроса — GetAccountsRequest
-
Тело ответа — GetAccountsResponse
GetMarginAttributes
Расчёт маржинальных показателей по счёту.
-
Тело запроса — GetMarginAttributesRequest
-
Тело ответа — GetMarginAttributesResponse
GetUserTariff
Запрос тарифа пользователя.
-
Тело запроса — GetUserTariffRequest
-
Тело ответа — GetUserTariffResponse
GetInfo
Метод получения информации о пользователе.
-
Тело запроса — GetInfoRequest
-
Тело ответа — GetInfoResponse
Сообщения методов
GetAccountsRequest
Запрос получения счетов пользователя.
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 | Названия методов. |
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 | Наименование тарифа пользователя. |
Enums
AccountType
Тип счёта.
Name | Number | Description |
---|---|---|
ACCOUNT_TYPE_UNSPECIFIED | 0 | Тип аккаунта не определён. |
ACCOUNT_TYPE_TINKOFF | 1 | Брокерский счёт Тинькофф. |
ACCOUNT_TYPE_TINKOFF_IIS | 2 | ИИС счёт. |
ACCOUNT_TYPE_INVEST_BOX | 3 | Инвесткопилка. |
AccountStatus
Статус счёта.
Name | Number | Description |
---|---|---|
ACCOUNT_STATUS_UNSPECIFIED | 0 | Статус счёта не определён. |
ACCOUNT_STATUS_NEW | 1 | Новый, в процессе открытия. |
ACCOUNT_STATUS_OPEN | 2 | Открытый и активный счёт. |
ACCOUNT_STATUS_CLOSED | 3 | Закрытый счёт. |
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 | Доступ отсутствует. |
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 | Дробная часть суммы, может быть отрицательным числом |