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

Методы

UsersService

С помощью сервиса можно получить:
1. список счетов пользователя;
2. маржинальные показатели по счёту.

Методы сервиса

GetAccounts

Получить счета пользователя.

GetMarginAttributes

Рассчитать маржинальные показатели по счёту.

GetUserTariff

Запросить тариф пользователя.

GetInfo

Получить информацию о пользователе.

Сообщения методов

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 Инвесткопилка.
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 Закрытый счёт.

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 Дробная часть суммы, может быть отрицательным числом