openapi: "3.0.1"
info:
title: "T-Invest API"
termsOfService: "https://www.tbank.ru/invest/disclaimers/basic-information/"
contact:
email: "al.a.volkov@tbank.ru"
version: "1.30"
license:
name: "Apache 2.0"
url: "https://www.apache.org/licenses/LICENSE-2.0"
servers:
- url: "https://invest-public-api.tinkoff.ru/rest"
description: "Работа с биржей"
- url: "https://sandbox-invest-public-api.tinkoff.ru/rest"
description: "Работа в песочнице"
security:
- Bearer: []
externalDocs:
description: "Документация T-Invest API"
url: "https://russianinvestments.github.io/investAPI/"
tags:
- name: "InstrumentsService"
- name: "MarketDataService"
- name: "OperationsService"
- name: "OrdersService"
- name: "SandboxService"
- name: "StopOrdersService"
- name: "UsersService"
paths:
/tinkoff.public.invest.api.contract.v1.InstrumentsService/BondBy:
post:
operationId: "InstrumentsService_BondBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1BondResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить облигации по ее идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Bonds:
post:
operationId: "InstrumentsService_Bonds"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1BondsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список облигаций"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/CreateFavoriteGroup:
post:
operationId: "InstrumentsService_CreateFavoriteGroup"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1CreateFavoriteGroupRequest"
description: "Запрос создания новой группы избранных инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CreateFavoriteGroupResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Создать новую группу избранных инструментов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Currencies:
post:
operationId: "InstrumentsService_Currencies"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CurrenciesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список валют"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/CurrencyBy:
post:
operationId: "InstrumentsService_CurrencyBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CurrencyResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить валюту по ее идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/DeleteFavoriteGroup:
post:
operationId: "InstrumentsService_DeleteFavoriteGroup"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1DeleteFavoriteGroupRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1DeleteFavoriteGroupResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Удалить группу избранных инструментов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/EditFavorites:
post:
operationId: "InstrumentsService_EditFavorites"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1EditFavoritesRequest"
description: "Запрос редактирования списка избранных инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1EditFavoritesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Отредактировать список избранных инструментов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/EtfBy:
post:
operationId: "InstrumentsService_EtfBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1EtfResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить инвестиционный фонд по его идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Etfs:
post:
operationId: "InstrumentsService_Etfs"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1EtfsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список инвестиционных фондов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/FindInstrument:
post:
operationId: "InstrumentsService_FindInstrument"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1FindInstrumentRequest"
description: "Запрос на поиск инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1FindInstrumentResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Найти инструмент"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/FutureBy:
post:
operationId: "InstrumentsService_FutureBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1FutureResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить фьючерс по его идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Futures:
post:
operationId: "InstrumentsService_Futures"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1FuturesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список фьючерсов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetAccruedInterests:
post:
operationId: "InstrumentsService_GetAccruedInterests"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccruedInterestsRequest"
description: "Запрос НКД по облигации."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccruedInterestsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить накопленный купонный доход по облигации"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetAssetBy:
post:
operationId: "InstrumentsService_GetAssetBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1AssetRequest"
description: "Запрос актива по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1AssetResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить актив по его идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetAssetFundamentals:
post:
operationId: "InstrumentsService_GetAssetFundamentals"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAssetFundamentalsRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAssetFundamentalsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить фундаментальные показатели по активу"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetAssetReports:
post:
operationId: "InstrumentsService_GetAssetReports"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAssetReportsRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAssetReportsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить расписания выхода отчетностей эмитентов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetAssets:
post:
operationId: "InstrumentsService_GetAssets"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1AssetsRequest"
description: "Запрос списка активов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1AssetsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список активов. Метод работает для всех инструментов, кроме срочных — фьючерсов и опционов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBondCoupons:
post:
operationId: "InstrumentsService_GetBondCoupons"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBondCouponsRequest"
description: "Запрос купонов по облигации."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBondCouponsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить график выплат купонов по облигации"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBondEvents:
post:
operationId: "InstrumentsService_GetBondEvents"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBondEventsRequest"
description: "События по облигации."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBondEventsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить события по облигации"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBrandBy:
post:
operationId: "InstrumentsService_GetBrandBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBrandRequest"
description: "Запрос бренда."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1Brand"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить бренд по его идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBrands:
post:
operationId: "InstrumentsService_GetBrands"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBrandsRequest"
description: "Запрос списка брендов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetBrandsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список брендов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetConsensusForecasts:
post:
operationId: "InstrumentsService_GetConsensusForecasts"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetConsensusForecastsRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetConsensusForecastsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить мнения аналитиков по инструменту"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetCountries:
post:
operationId: "InstrumentsService_GetCountries"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetCountriesRequest"
description: "Запрос справочника стран."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetCountriesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список стран"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetDividends:
post:
operationId: "InstrumentsService_GetDividends"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetDividendsRequest"
description: "Запрос дивидендов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetDividendsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить события выплаты дивидендов по инструменту"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetFavoriteGroups:
post:
operationId: "InstrumentsService_GetFavoriteGroups"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFavoriteGroupsRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFavoriteGroupsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список групп избранных инструментов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetFavorites:
post:
operationId: "InstrumentsService_GetFavorites"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFavoritesRequest"
description: "Запрос списка избранных инструментов, входные параметры не требуются."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFavoritesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список избранных инструментов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetForecastBy:
post:
operationId: "InstrumentsService_GetForecastBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetForecastRequest"
description: "Запрос прогнозов инвестдомов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetForecastResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить прогнозов инвестдомов по инструменту"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetFuturesMargin:
post:
operationId: "InstrumentsService_GetFuturesMargin"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFuturesMarginRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetFuturesMarginResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить размера гарантийного обеспечения по фьючерсам"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetInstrumentBy:
post:
operationId: "InstrumentsService_GetInstrumentBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить основную информацию об инструменте"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetRiskRates:
post:
operationId: "InstrumentsService_GetRiskRates"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1RiskRatesRequest"
description: "Запрос ставок риска"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1RiskRatesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить ставки риска по инструменту"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Indicatives:
post:
operationId: "InstrumentsService_Indicatives"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1IndicativesRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1IndicativesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить индикативные инструменты — индексы, товары и другие"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/OptionBy:
post:
operationId: "InstrumentsService_OptionBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OptionResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить опцион по его идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Options:
post:
operationId: "InstrumentsService_Options"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OptionsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Deprecated Получить список опционов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/OptionsBy:
post:
operationId: "InstrumentsService_OptionsBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1FilterOptionsRequest"
description: "Параметры фильтрации опционов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OptionsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список опционов"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/ShareBy:
post:
operationId: "InstrumentsService_ShareBy"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentRequest"
description: "Запрос получения инструмента по идентификатору."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1ShareResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить акцию по ее идентификатору"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/Shares:
post:
operationId: "InstrumentsService_Shares"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1InstrumentsRequest"
description: "Запрос получения инструментов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1SharesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список акций"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.InstrumentsService/TradingSchedules:
post:
operationId: "InstrumentsService_TradingSchedules"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1TradingSchedulesRequest"
description: "Запрос расписания торгов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1TradingSchedulesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить расписания торгов торговых площадок"
tags:
- "InstrumentsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetCandles:
post:
operationId: "MarketDataService_GetCandles"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetCandlesRequest"
description: "Запрос исторических свечей."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetCandlesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить исторические свечи по инструменту."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetClosePrices:
post:
operationId: "MarketDataService_GetClosePrices"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetClosePricesRequest"
description: "Запрос цен закрытия торговой сессии по инструментам."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetClosePricesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить цены закрытия торговой сессии по инструментам."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetLastPrices:
post:
operationId: "MarketDataService_GetLastPrices"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetLastPricesRequest"
description: "Запрос получения цен последних сделок."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetLastPricesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить цены последних сделок по инструментам."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetLastTrades:
post:
operationId: "MarketDataService_GetLastTrades"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetLastTradesRequest"
description: "Запрос обезличенных сделок за последний час."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetLastTradesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить обезличенные сделки за последний час."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetOrderBook:
post:
operationId: "MarketDataService_GetOrderBook"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderBookRequest"
description: "Запрос стакана."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderBookResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить стакан по инструменту."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetTechAnalysis:
post:
operationId: "MarketDataService_GetTechAnalysis"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTechAnalysisRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTechAnalysisResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить технические индикаторы по инструменту."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetTradingStatus:
post:
operationId: "MarketDataService_GetTradingStatus"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTradingStatusRequest"
description: "Запрос получения торгового статуса."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTradingStatusResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить статус торгов по инструментам."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataService/GetTradingStatuses:
post:
operationId: "MarketDataService_GetTradingStatuses"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTradingStatusesRequest"
description: "Запрос получения торгового статуса."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetTradingStatusesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить статус торгов по инструментам."
tags:
- "MarketDataService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataStreamService/MarketDataServerSideStream:
post:
operationId: "MarketDataStreamService_MarketDataServerSideStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1MarketDataServerSideStreamRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1MarketDataResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Server-side стрим предоставления биржевой информации."
tags:
- "MarketDataStreamService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.MarketDataStreamService/MarketDataStream:
post:
operationId: "MarketDataStreamService_MarketDataStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1MarketDataRequest"
description: "Запрос подписки или отписки на определенные биржевые данные. (streaming inputs)"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1MarketDataResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Bidirectional-стрим предоставления биржевой информации."
tags:
- "MarketDataStreamService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsService/GetBrokerReport:
post:
operationId: "OperationsService_GetBrokerReport"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1BrokerReportRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1BrokerReportResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить брокерский отчет."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsService/GetDividendsForeignIssuer:
post:
operationId: "OperationsService_GetDividendsForeignIssuer"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetDividendsForeignIssuerRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetDividendsForeignIssuerResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить отчет «Справка о доходах за пределами РФ»."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsService/GetOperations:
post:
operationId: "OperationsService_GetOperations"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1OperationsRequest"
description: "Запрос получения списка операций по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OperationsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список операций по счету."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
description: "При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems)."
/tinkoff.public.invest.api.contract.v1.OperationsService/GetOperationsByCursor:
post:
operationId: "OperationsService_GetOperationsByCursor"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOperationsByCursorRequest"
description: "Запрос списка операций по счету с пагинацией."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOperationsByCursorResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список операций по счету с пагинацией."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
description: "При работе с методом учитывайте [особенности взаимодействия](/invest/services/operations/operations_problems)."
/tinkoff.public.invest.api.contract.v1.OperationsService/GetPortfolio:
post:
operationId: "OperationsService_GetPortfolio"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PortfolioRequest"
description: "Запрос получения текущего портфеля по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PortfolioResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить портфель по счету."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsService/GetPositions:
post:
operationId: "OperationsService_GetPositions"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PositionsRequest"
description: "Запрос позиций портфеля по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PositionsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список позиций по счету."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsService/GetWithdrawLimits:
post:
operationId: "OperationsService_GetWithdrawLimits"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1WithdrawLimitsRequest"
description: "Запрос доступного остатка для вывода."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1WithdrawLimitsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить доступный остаток для вывода средств."
tags:
- "OperationsService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsStreamService/PortfolioStream:
post:
operationId: "OperationsStreamService_PortfolioStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PortfolioStreamRequest"
description: "Запрос установки stream-соединения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1PortfolioStreamResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Server-side stream обновлений портфеля."
tags:
- "OperationsStreamService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OperationsStreamService/PositionsStream:
post:
operationId: "OperationsStreamService_PositionsStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PositionsStreamRequest"
description: "Запрос установки stream-соединения позиций."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1PositionsStreamResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Server-side stream обновлений информации по изменению позиций портфеля."
tags:
- "OperationsStreamService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/CancelOrder:
post:
operationId: "OrdersService_CancelOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelOrderRequest"
description: "Запрос отмены торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод отмены биржевой заявки."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/GetMaxLots:
post:
operationId: "OrdersService_GetMaxLots"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMaxLotsRequest"
description: "Запрос на расчет количества доступных для покупки/продажи лотов. Если не указывать цену инструмента, то расчет произведется по текущум ценам в стакане: по лучшему предложению для покупки и по лучшему спросу для продажи."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMaxLotsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Расчет количества доступных для покупки/продажи лотов."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/GetOrderPrice:
post:
operationId: "OrdersService_GetOrderPrice"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderPriceRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderPriceResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод получения предварительной стоимости для лимитной заявки."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/GetOrderState:
post:
operationId: "OrdersService_GetOrderState"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderStateRequest"
description: "Запрос получения статуса торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/contractv1OrderState"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод получения статуса торгового поручения."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/GetOrders:
post:
operationId: "OrdersService_GetOrders"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrdersRequest"
description: "Запрос получения списка активных торговых поручений."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrdersResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод получения списка активных заявок по счету."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrder:
post:
operationId: "OrdersService_PostOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderRequest"
description: "Запрос выставления торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод выставления заявки."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrderAsync:
post:
operationId: "OrdersService_PostOrderAsync"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderAsyncRequest"
description: "Запрос выставления асинхронного торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderAsyncResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Асинхронный метод выставления заявки."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersService/ReplaceOrder:
post:
operationId: "OrdersService_ReplaceOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1ReplaceOrderRequest"
description: "Запрос изменения выставленной заявки."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Метод изменения выставленной заявки."
tags:
- "OrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.OrdersStreamService/OrderStateStream:
post:
operationId: "OrdersStreamService_OrderStateStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1OrderStateStreamRequest"
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1OrderStateStreamResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Stream поручений пользователя."
tags:
- "OrdersStreamService"
x-codegen-request-body-name: "body"
description: "Перед работой прочитайте [статью](/invest/services/orders/orders_state_stream)."
/tinkoff.public.invest.api.contract.v1.OrdersStreamService/TradesStream:
post:
operationId: "OrdersStreamService_TradesStream"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1TradesStreamRequest"
description: "Запрос установки соединения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Stream_result_of_v1TradesStreamResponse"
description: "A successful response.(streaming responses)"
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Stream сделок пользователя."
tags:
- "OrdersStreamService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/CancelSandboxOrder:
post:
operationId: "SandboxService_CancelSandboxOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelOrderRequest"
description: "Запрос отмены торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Отменить торговое поручение."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/CloseSandboxAccount:
post:
operationId: "SandboxService_CloseSandboxAccount"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1CloseSandboxAccountRequest"
description: "Запрос закрытия счета в песочнице."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CloseSandboxAccountResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Закрыть счет."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxAccounts:
post:
operationId: "SandboxService_GetSandboxAccounts"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccountsRequest"
description: "Запрос получения счетов пользователя."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccountsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить счета."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxMaxLots:
post:
operationId: "SandboxService_GetSandboxMaxLots"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMaxLotsRequest"
description: "Запрос на расчет количества доступных для покупки/продажи лотов. Если не указывать цену инструмента, то расчет произведется по текущум ценам в стакане: по лучшему предложению для покупки и по лучшему спросу для продажи."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMaxLotsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Расчет количества доступных для покупки/продажи лотов в песочнице."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxOperations:
post:
operationId: "SandboxService_GetSandboxOperations"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1OperationsRequest"
description: "Запрос получения списка операций по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OperationsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить операции по номеру счета."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxOperationsByCursor:
post:
operationId: "SandboxService_GetSandboxOperationsByCursor"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOperationsByCursorRequest"
description: "Запрос списка операций по счету с пагинацией."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOperationsByCursorResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить операции по номеру счета с пагинацией."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxOrderState:
post:
operationId: "SandboxService_GetSandboxOrderState"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrderStateRequest"
description: "Запрос получения статуса торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/contractv1OrderState"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить статус заявки в песочнице. Заявки хранятся в таблице 7 дней."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxOrders:
post:
operationId: "SandboxService_GetSandboxOrders"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrdersRequest"
description: "Запрос получения списка активных торговых поручений."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetOrdersResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список активных заявок по счету."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxPortfolio:
post:
operationId: "SandboxService_GetSandboxPortfolio"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PortfolioRequest"
description: "Запрос получения текущего портфеля по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PortfolioResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить портфель."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxPositions:
post:
operationId: "SandboxService_GetSandboxPositions"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PositionsRequest"
description: "Запрос позиций портфеля по счету."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PositionsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить позиции по виртуальному счету."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/GetSandboxWithdrawLimits:
post:
operationId: "SandboxService_GetSandboxWithdrawLimits"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1WithdrawLimitsRequest"
description: "Запрос доступного остатка для вывода."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1WithdrawLimitsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить доступный остаток для вывода средств."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/OpenSandboxAccount:
post:
operationId: "SandboxService_OpenSandboxAccount"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1OpenSandboxAccountRequest"
description: "Запрос открытия счета в песочнице."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1OpenSandboxAccountResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Зарегистрировать счет."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/PostSandboxOrder:
post:
operationId: "SandboxService_PostSandboxOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderRequest"
description: "Запрос выставления торгового поручения."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Выставить торговое поручение."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/ReplaceSandboxOrder:
post:
operationId: "SandboxService_ReplaceSandboxOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1ReplaceOrderRequest"
description: "Запрос изменения выставленной заявки."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Изменить выставленную заявку."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SandboxService/SandboxPayIn:
post:
operationId: "SandboxService_SandboxPayIn"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1SandboxPayInRequest"
description: "Запрос пополнения счета в песочнице."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1SandboxPayInResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Пополнить счет."
tags:
- "SandboxService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SignalService/GetSignals:
post:
operationId: "SignalService_GetSignals"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetSignalsRequest"
description: "Запрос сигналов."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetSignalsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить сигналы."
tags:
- "SignalService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.SignalService/GetStrategies:
post:
operationId: "SignalService_GetStrategies"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetStrategiesRequest"
description: "Запрос стратегий."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetStrategiesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить стратегии."
tags:
- "SignalService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.StopOrdersService/CancelStopOrder:
post:
operationId: "StopOrdersService_CancelStopOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelStopOrderRequest"
description: "Запрос отмены выставленной стоп-заявки."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1CancelStopOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Отменить стоп-заявку."
tags:
- "StopOrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.StopOrdersService/GetStopOrders:
post:
operationId: "StopOrdersService_GetStopOrders"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetStopOrdersRequest"
description: "Запрос получения списка активных стоп-заявок."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetStopOrdersResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить список активных стоп-заявок по счету."
tags:
- "StopOrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.StopOrdersService/PostStopOrder:
post:
operationId: "StopOrdersService_PostStopOrder"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostStopOrderRequest"
description: "Запрос выставления стоп-заявки."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1PostStopOrderResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Выставить стоп-заявку."
tags:
- "StopOrdersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.UsersService/GetAccounts:
post:
operationId: "UsersService_GetAccounts"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccountsRequest"
description: "Запрос получения счетов пользователя."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetAccountsResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить счета пользователя."
tags:
- "UsersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.UsersService/GetInfo:
post:
operationId: "UsersService_GetInfo"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetInfoRequest"
description: "Запрос информации о пользователе."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetInfoResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Получить информацию о пользователе."
tags:
- "UsersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.UsersService/GetMarginAttributes:
post:
operationId: "UsersService_GetMarginAttributes"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMarginAttributesRequest"
description: "Запрос маржинальных показателей по счёту."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetMarginAttributesResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Рассчитать маржинальные показатели по счёту."
tags:
- "UsersService"
x-codegen-request-body-name: "body"
/tinkoff.public.invest.api.contract.v1.UsersService/GetUserTariff:
post:
operationId: "UsersService_GetUserTariff"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetUserTariffRequest"
description: "Запрос текущих лимитов пользователя."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/v1GetUserTariffResponse"
description: "A successful response."
"400":
description: "Запрос составлен неверно, проверьте параметры вызова и синтаксические ошибки."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 3
message: "interval is invalid"
description: 30011
"401":
description: "Токен доступа не найден или не активен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 16
message: "authentication token is missing or invalid"
description: 40003
"403":
description: "Недостаточно прав для выполнения запроса, проверьте соответствие токена и передаваемого в запросе счета."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 7
message: "insufficient privileges"
description: 40002
"404":
description: "Неверный URL запроса или переданный параметр не определен."
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/ErrorResponse"
example:
code: 5
message: "account not found"
description: 50004
"408":
description: "Время передачи запроса клиентом истекло. Проверьте работу приложения."
"415":
description: "Неверный тип данных, проверьте формат передаваемого сообщения."
"429":
description: "Превышен лимит запросов в минуту."
"500":
description: "Внутренняя ошибка сервера, попробуйте повторить запрос позже"
"501":
description: "Метод не реализован, проверьте путь вызова в запросе."
"503":
description: "Сервис временно недоступен, попробуйте повторить запрос позже."
"504":
description: "Превышен интервал ожидания ответа от сервера, попробуйте повторить запрос позже."
default:
content:
application/json:
schema:
$ref: "#/components/schemas/rpcStatus"
description: "An unexpected error response."
summary: "Запросить тариф пользователя."
tags:
- "UsersService"
x-codegen-request-body-name: "body"
components:
schemas:
GetAssetFundamentalsResponseStatisticResponse:
example:
domicileIndicatorCode: "domicileIndicatorCode"
assetUid: "assetUid"
dividendYieldDailyTtm: 3.0937452626664474
priceToSalesTtm: 4.965218492984954
adrToCommonShareRatio: 7.740351818741173
highPriceLast52Weeks: 6.027456183070403
dividendRateTtm: 7.143538047012306
revenueChangeFiveYears: 3.0576100241049344
totalDebtMrq: 1.284659006116532
fiveYearAnnualRevenueGrowthRate: 6.84685269835264
fiveYearAnnualDividendGrowthRate: 6.519180951018382
freeFloat: 7.061401241503109
freeCashFlowToPrice: 6.878052220127876
revenueTtm: 2.027123023002322
totalEnterpriseValueMrq: 9.369310271410669
epsTtm: 1.2315135367772556
peRatioTtm: 1.1730742509559433
fiscalPeriodStartDate: 2000-01-23T04:56:07.000Z
evToSales: 4.078845849666752
fiscalPeriodEndDate: 2000-01-23T04:56:07.000Z
roic: 6.965117697638846
dividendPayoutRatioFy: 0.10263654006109402
marketCapitalization: 0.8008281904610115
ebitdaChangeFiveYears: 5.533258397034986
epsChangeFiveYears: 7.04836565559697
priceToFreeCashFlowTtm: 9.965781217890562
numberOfEmployees: 3.0205796992916243
netInterestMarginMrq: 9.018348186070783
oneYearAnnualRevenueGrowthRate: 8.969578798196912
currentRatioMrq: 6.704019297950036
averageDailyVolumeLast4Weeks: 5.637376656633329
forwardAnnualDividendYield: 9.301444243932576
netMarginMrq: 8.762042012749001
roa: 3.5571952270680973
totalDebtToEbitdaMrq: 6.778324963048013
roe: 6.438423552598547
freeCashFlowTtm: 1.4894159098541704
evToEbitdaMrq: 6.683562403749608
fiveYearsAverageDividendYield: 7.058770351582356
priceToBookTtm: 5.025004791520295
totalDebtToEquityMrq: 2.8841621266687802
averageDailyVolumeLast10Days: 5.962133916683182
fixedChargeCoverageRatioFy: 3.353193347011243
currency: "currency"
netIncomeTtm: 7.386281948385884
sharesOutstanding: 3.616076749251911
beta: 2.3021358869347655
threeYearAnnualRevenueGrowthRate: 7.457744773683766
totalDebtChangeFiveYears: 3.2588565619047607
lowPriceLast52Weeks: 1.4658129805029452
exDividendDate: 2000-01-23T04:56:07.000Z
ebitdaTtm: 4.145608029883936
netDebtToEbitda: 5.944895607614016
dilutedEpsTtm: 1.0246457001441578
buyBackTtm: 4.652396432933246
dividendsPerShare: 0.8851374739011653
properties:
assetUid:
description: "Идентификатор актива."
type: "string"
currency:
description: "Валюта."
type: "string"
marketCapitalization:
description: "Рыночная капитализация."
format: "double"
type: "number"
highPriceLast52Weeks:
description: "Максимум за год."
format: "double"
type: "number"
lowPriceLast52Weeks:
description: "Минимум за год."
format: "double"
type: "number"
averageDailyVolumeLast10Days:
description: "Средний объем торгов за 10 дней."
format: "double"
type: "number"
averageDailyVolumeLast4Weeks:
description: "Средний объем торгов за месяц."
format: "double"
type: "number"
beta:
format: "double"
type: "number"
freeFloat:
description: "Доля акций в свободном обращении."
format: "double"
type: "number"
forwardAnnualDividendYield:
description: "Процент форвардной дивидендной доходности по отношению к цене акций."
format: "double"
type: "number"
sharesOutstanding:
description: "Количество акций в обращении."
format: "double"
type: "number"
revenueTtm:
description: "Выручка."
format: "double"
type: "number"
ebitdaTtm:
description: "EBITDA — прибыль до вычета процентов, налогов, износа и амортизации."
format: "double"
type: "number"
netIncomeTtm:
description: "Чистая прибыль."
format: "double"
type: "number"
epsTtm:
description: "EPS — величина чистой прибыли компании, которая приходится на каждую обыкновенную акцию."
format: "double"
type: "number"
dilutedEpsTtm:
description: "EPS компании с допущением, что все конвертируемые ценные бумаги компании были сконвертированы в обыкновенные акции."
format: "double"
type: "number"
freeCashFlowTtm:
description: "Свободный денежный поток."
format: "double"
type: "number"
fiveYearAnnualRevenueGrowthRate:
description: "Среднегодовой рocт выручки за 5 лет."
format: "double"
type: "number"
threeYearAnnualRevenueGrowthRate:
description: "Среднегодовой рocт выручки за 3 года."
format: "double"
type: "number"
peRatioTtm:
description: "Соотношение рыночной капитализации компании к ее чистой прибыли."
format: "double"
type: "number"
priceToSalesTtm:
description: "Соотношение рыночной капитализации компании к ее выручке."
format: "double"
type: "number"
priceToBookTtm:
description: "Соотношение рыночной капитализации компании к ее балансовой стоимости."
format: "double"
type: "number"
priceToFreeCashFlowTtm:
description: "Соотношение рыночной капитализации компании к ее свободному денежному потоку."
format: "double"
type: "number"
totalEnterpriseValueMrq:
description: "Рыночная стоимость компании."
format: "double"
type: "number"
evToEbitdaMrq:
description: "Соотношение EV и EBITDA."
format: "double"
type: "number"
netMarginMrq:
description: "Маржа чистой прибыли."
format: "double"
type: "number"
netInterestMarginMrq:
description: "Рентабельность чистой прибыли."
format: "double"
type: "number"
roe:
description: "Рентабельность собственного капитала."
format: "double"
type: "number"
roa:
description: "Рентабельность активов."
format: "double"
type: "number"
roic:
description: "Рентабельность активов."
format: "double"
type: "number"
totalDebtMrq:
description: "Сумма краткосрочных и долгосрочных обязательств компании."
format: "double"
type: "number"
totalDebtToEquityMrq:
description: "Соотношение долга к собственному капиталу."
format: "double"
type: "number"
totalDebtToEbitdaMrq:
description: "Total Debt/EBITDA."
format: "double"
type: "number"
freeCashFlowToPrice:
description: "Отношение свободногоо кэша к стоимости."
format: "double"
type: "number"
netDebtToEbitda:
description: "Отношение чистого долга к EBITDA."
format: "double"
type: "number"
currentRatioMrq:
description: "Коэффициент текущей ликвидности."
format: "double"
type: "number"
fixedChargeCoverageRatioFy:
description: "Коэффициент покрытия фиксированных платежей — FCCR."
format: "double"
type: "number"
dividendYieldDailyTtm:
description: "Дивидендная доходность за 12 месяцев."
format: "double"
type: "number"
dividendRateTtm:
description: "Выплаченные дивиденды за 12 месяцев."
format: "double"
type: "number"
dividendsPerShare:
description: "Значение дивидендов на акцию."
format: "double"
type: "number"
fiveYearsAverageDividendYield:
description: "Средняя дивидендная доходность за 5 лет."
format: "double"
type: "number"
fiveYearAnnualDividendGrowthRate:
description: "Среднегодовой рост дивидендов за 5 лет."
format: "double"
type: "number"
dividendPayoutRatioFy:
description: "Процент чистой прибыли, уходящий на выплату дивидендов."
format: "double"
type: "number"
buyBackTtm:
description: "Деньги, потраченные на обратный выкуп акций."
format: "double"
type: "number"
oneYearAnnualRevenueGrowthRate:
description: "Рост выручки за 1 год."
format: "double"
type: "number"
domicileIndicatorCode:
description: "Код страны."
type: "string"
adrToCommonShareRatio:
description: "Соотношение депозитарной расписки к акциям."
format: "double"
type: "number"
numberOfEmployees:
description: "Количество сотрудников."
format: "double"
type: "number"
exDividendDate:
format: "date-time"
type: "string"
fiscalPeriodStartDate:
description: "Начало фискального периода."
format: "date-time"
type: "string"
fiscalPeriodEndDate:
description: "Окончание фискального периода."
format: "date-time"
type: "string"
revenueChangeFiveYears:
description: "Изменение общего дохода за 5 лет."
format: "double"
type: "number"
epsChangeFiveYears:
description: "Изменение EPS за 5 лет."
format: "double"
type: "number"
ebitdaChangeFiveYears:
description: "Изменение EBIDTA за 5 лет."
format: "double"
type: "number"
totalDebtChangeFiveYears:
description: "Изменение общей задолжности за 5 лет."
format: "double"
type: "number"
evToSales:
description: "Отношение EV к выручке."
format: "double"
type: "number"
title: "Фундаментальные показатели по активу"
type: "object"
GetAssetReportsResponseAssetReportPeriodType:
default: "PERIOD_TYPE_UNSPECIFIED"
description: " - PERIOD_TYPE_UNSPECIFIED: Не указан.\n - PERIOD_TYPE_QUARTER: Квартальный.\n - PERIOD_TYPE_SEMIANNUAL: Полугодовой.\n - PERIOD_TYPE_ANNUAL: Годовой."
enum:
- "PERIOD_TYPE_UNSPECIFIED"
- "PERIOD_TYPE_QUARTER"
- "PERIOD_TYPE_SEMIANNUAL"
- "PERIOD_TYPE_ANNUAL"
type: "string"
GetAssetReportsResponseGetAssetReportsEvent:
example:
periodNum: 6
createdAt: 2000-01-23T04:56:07.000Z
reportDate: 2000-01-23T04:56:07.000Z
periodYear: 0
instrumentId: "instrumentId"
properties:
instrumentId:
description: "Идентификатор инструмента."
type: "string"
reportDate:
description: "Дата публикации отчета."
format: "date-time"
type: "string"
periodYear:
description: "Год периода отчета."
format: "int32"
type: "integer"
periodNum:
description: "Номер периода."
format: "int32"
type: "integer"
periodType:
$ref: "#/components/schemas/GetAssetReportsResponseAssetReportPeriodType"
createdAt:
description: "Дата создания записи."
format: "date-time"
type: "string"
title: "Отчет"
type: "object"
GetBondEventsRequestEventType:
default: "EVENT_TYPE_UNSPECIFIED"
description: " - EVENT_TYPE_UNSPECIFIED: Неопределенное значение.\n - EVENT_TYPE_CPN: Купон.\n - EVENT_TYPE_CALL: Опцион (оферта).\n - EVENT_TYPE_MTY: Погашение.\n - EVENT_TYPE_CONV: Конвертация."
enum:
- "EVENT_TYPE_UNSPECIFIED"
- "EVENT_TYPE_CPN"
- "EVENT_TYPE_CALL"
- "EVENT_TYPE_MTY"
- "EVENT_TYPE_CONV"
type: "string"
GetBondEventsResponseBondEvent:
example:
fixDate: 2000-01-23T04:56:07.000Z
execution: "execution"
note: "note"
defaultDate: 2000-01-23T04:56:07.000Z
eventNumber: 0
instrumentId: "instrumentId"
couponEndDate: 2000-01-23T04:56:07.000Z
rateDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
moneyFlowVal:
nano: 5
currency: "currency"
units: "units"
couponPeriod: 6
convertToFinToolId: "convertToFinToolId"
couponInterestRate:
nano: 6
units: "units"
eventTotalVol:
nano: 6
units: "units"
realPayDate: 2000-01-23T04:56:07.000Z
operationType: "operationType"
value:
nano: 6
units: "units"
couponStartDate: 2000-01-23T04:56:07.000Z
eventDate: 2000-01-23T04:56:07.000Z
payDate: 2000-01-23T04:56:07.000Z
properties:
instrumentId:
description: "Идентификатор инструмента."
type: "string"
eventNumber:
description: "Номер события для данного типа события."
format: "int32"
type: "integer"
eventDate:
description: "Дата события."
format: "date-time"
type: "string"
eventType:
$ref: "#/components/schemas/GetBondEventsRequestEventType"
eventTotalVol:
$ref: "#/components/schemas/v1Quotation"
fixDate:
description: "Дата фиксации владельцев для участия в событии."
format: "date-time"
type: "string"
rateDate:
description: "Дата определения даты или факта события."
format: "date-time"
type: "string"
defaultDate:
description: "Дата дефолта, если применимо."
format: "date-time"
type: "string"
realPayDate:
description: "Дата реального исполнения обязательства."
format: "date-time"
type: "string"
payDate:
description: "Дата выплаты."
format: "date-time"
type: "string"
payOneBond:
$ref: "#/components/schemas/v1MoneyValue"
moneyFlowVal:
$ref: "#/components/schemas/v1MoneyValue"
execution:
description: "Признак исполнения."
type: "string"
operationType:
description: "Тип операции."
type: "string"
value:
$ref: "#/components/schemas/v1Quotation"
note:
description: "Примечание."
type: "string"
convertToFinToolId:
description: "ID выпуска бумаг, в который произведена конвертация (для конвертаций)."
type: "string"
couponStartDate:
description: "Начало купонного периода."
format: "date-time"
type: "string"
couponEndDate:
description: "Окончание купонного периода."
format: "date-time"
type: "string"
couponPeriod:
description: "Купонный период."
format: "int32"
type: "integer"
couponInterestRate:
$ref: "#/components/schemas/v1Quotation"
type: "object"
GetConsensusForecastsResponseConsensusForecastsItem:
example:
uid: "uid"
assetUid: "assetUid"
createdAt: 2000-01-23T04:56:07.000Z
bestTargetHigh:
nano: 6
units: "units"
bestTargetLow:
nano: 6
units: "units"
totalSellRecommend: 1
currency: "currency"
bestTargetPrice:
nano: 6
units: "units"
totalHoldRecommend: 6
prognosisDate: 2000-01-23T04:56:07.000Z
totalBuyRecommend: 0
properties:
uid:
description: "UID-идентификатор."
type: "string"
assetUid:
description: "UID-идентификатор актива."
type: "string"
createdAt:
description: "Дата и время создания записи."
format: "date-time"
type: "string"
bestTargetPrice:
$ref: "#/components/schemas/v1Quotation"
bestTargetLow:
$ref: "#/components/schemas/v1Quotation"
bestTargetHigh:
$ref: "#/components/schemas/v1Quotation"
totalBuyRecommend:
description: "Количество аналитиков рекомендующих покупать."
format: "int32"
type: "integer"
totalHoldRecommend:
description: "Количество аналитиков рекомендующих держать."
format: "int32"
type: "integer"
totalSellRecommend:
description: "Количество аналитиков рекомендующих продавать."
format: "int32"
type: "integer"
currency:
description: "Валюта прогнозов инструмента."
type: "string"
consensus:
$ref: "#/components/schemas/v1Recommendation"
prognosisDate:
description: "Дата прогноза."
format: "date-time"
type: "string"
title: "Прогноз"
type: "object"
GetFavoriteGroupsResponseFavoriteGroup:
example:
groupName: "groupName"
color: "color"
size: 0
containsInstrument: true
groupId: "groupId"
properties:
groupId:
description: "Уникальный идентификатор группы."
type: "string"
groupName:
description: "Название группы."
type: "string"
color:
description: "Цвет группы в HEX-формате."
type: "string"
size:
description: "Количество инструментов в группе."
format: "int32"
type: "integer"
containsInstrument:
description: "Признак наличия в группе хотя бы одного инструмента из запроса."
type: "boolean"
required:
- "color"
- "groupId"
- "groupName"
- "size"
type: "object"
GetForecastResponseConsensusItem:
description: "Консенсус-прогноз."
example:
consensus:
nano: 6
units: "units"
priceChange:
nano: 6
units: "units"
uid: "uid"
maxTarget:
nano: 6
units: "units"
ticker: "ticker"
priceChangeRel:
nano: 6
units: "units"
currentPrice:
nano: 6
units: "units"
currency: "currency"
minTarget:
nano: 6
units: "units"
properties:
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
recommendation:
$ref: "#/components/schemas/v1Recommendation"
currency:
description: "Валюта."
type: "string"
currentPrice:
$ref: "#/components/schemas/v1Quotation"
consensus:
$ref: "#/components/schemas/v1Quotation"
minTarget:
$ref: "#/components/schemas/v1Quotation"
maxTarget:
$ref: "#/components/schemas/v1Quotation"
priceChange:
$ref: "#/components/schemas/v1Quotation"
priceChangeRel:
$ref: "#/components/schemas/v1Quotation"
type: "object"
GetForecastResponseTargetItem:
example:
priceChange:
nano: 6
units: "units"
uid: "uid"
ticker: "ticker"
targetPrice:
nano: 6
units: "units"
showName: "showName"
priceChangeRel:
nano: 6
units: "units"
currentPrice:
nano: 6
units: "units"
company: "company"
currency: "currency"
recommendationDate: 2000-01-23T04:56:07.000Z
properties:
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
company:
description: "Название компании, давшей прогноз."
type: "string"
recommendation:
$ref: "#/components/schemas/v1Recommendation"
recommendationDate:
description: "Дата прогноза."
format: "date-time"
type: "string"
currency:
description: "Валюта."
type: "string"
currentPrice:
$ref: "#/components/schemas/v1Quotation"
targetPrice:
$ref: "#/components/schemas/v1Quotation"
priceChange:
$ref: "#/components/schemas/v1Quotation"
priceChangeRel:
$ref: "#/components/schemas/v1Quotation"
showName:
description: "Наименование инструмента."
type: "string"
title: "Прогноз"
type: "object"
GetMaxLotsResponseBuyLimitsView:
example:
buyMoneyAmount:
nano: 6
units: "units"
buyMaxLots: "buyMaxLots"
buyMaxMarketLots: "buyMaxMarketLots"
properties:
buyMoneyAmount:
$ref: "#/components/schemas/v1Quotation"
buyMaxLots:
format: "int64"
title: "Максимальное доступное количество лотов для покупки"
type: "string"
buyMaxMarketLots:
format: "int64"
title: "Максимальное доступное количество лотов для покупки для заявки по рыночной цене на текущий момент"
type: "string"
type: "object"
GetMaxLotsResponseSellLimitsView:
example:
sellMaxLots: "sellMaxLots"
properties:
sellMaxLots:
format: "int64"
title: "Максимальное доступное количество лотов для продажи"
type: "string"
type: "object"
GetOrderPriceResponseExtraBond:
example:
aciValue:
nano: 5
currency: "currency"
units: "units"
nominalConversionRate:
nano: 6
units: "units"
properties:
aciValue:
$ref: "#/components/schemas/v1MoneyValue"
nominalConversionRate:
$ref: "#/components/schemas/v1Quotation"
type: "object"
GetOrderPriceResponseExtraFuture:
example:
initialMargin:
nano: 5
currency: "currency"
units: "units"
properties:
initialMargin:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
GetTechAnalysisRequestDeviation:
properties:
deviationMultiplier:
$ref: "#/components/schemas/v1Quotation"
type: "object"
GetTechAnalysisRequestIndicatorInterval:
default: "INDICATOR_INTERVAL_UNSPECIFIED"
description: "Интервал свечи.\n\n - INDICATOR_INTERVAL_UNSPECIFIED: Интервал не определен.\n - INDICATOR_INTERVAL_ONE_MINUTE: 1 минута.\n - INDICATOR_INTERVAL_FIVE_MINUTES: 5 минут.\n - INDICATOR_INTERVAL_FIFTEEN_MINUTES: 15 минут.\n - INDICATOR_INTERVAL_ONE_HOUR: 1 час.\n - INDICATOR_INTERVAL_ONE_DAY: 1 день.\n - INDICATOR_INTERVAL_2_MIN: 2 минуты.\n - INDICATOR_INTERVAL_3_MIN: 3 минуты.\n - INDICATOR_INTERVAL_10_MIN: 10 минут.\n - INDICATOR_INTERVAL_30_MIN: 30 минут.\n - INDICATOR_INTERVAL_2_HOUR: 2 часа.\n - INDICATOR_INTERVAL_4_HOUR: 4 часа.\n - INDICATOR_INTERVAL_WEEK: Неделя.\n - INDICATOR_INTERVAL_MONTH: Месяц."
enum:
- "INDICATOR_INTERVAL_UNSPECIFIED"
- "INDICATOR_INTERVAL_ONE_MINUTE"
- "INDICATOR_INTERVAL_FIVE_MINUTES"
- "INDICATOR_INTERVAL_FIFTEEN_MINUTES"
- "INDICATOR_INTERVAL_ONE_HOUR"
- "INDICATOR_INTERVAL_ONE_DAY"
- "INDICATOR_INTERVAL_2_MIN"
- "INDICATOR_INTERVAL_3_MIN"
- "INDICATOR_INTERVAL_10_MIN"
- "INDICATOR_INTERVAL_30_MIN"
- "INDICATOR_INTERVAL_2_HOUR"
- "INDICATOR_INTERVAL_4_HOUR"
- "INDICATOR_INTERVAL_WEEK"
- "INDICATOR_INTERVAL_MONTH"
type: "string"
GetTechAnalysisRequestIndicatorType:
default: "INDICATOR_TYPE_UNSPECIFIED"
description: " - INDICATOR_TYPE_UNSPECIFIED: Не определен.\n - INDICATOR_TYPE_BB: Bollinger Bands — линия Боллинжера.\n - INDICATOR_TYPE_EMA: Exponential Moving Average — EMA, экспоненциальная скользящая средняя.\n - INDICATOR_TYPE_RSI: Relative Strength Index — индекс относительной силы.\n - INDICATOR_TYPE_MACD: Moving Average Convergence/Divergence — схождение/расхождение скользящих средних.\n - INDICATOR_TYPE_SMA: Simple Moving Average — простое скользящее среднее."
enum:
- "INDICATOR_TYPE_UNSPECIFIED"
- "INDICATOR_TYPE_BB"
- "INDICATOR_TYPE_EMA"
- "INDICATOR_TYPE_RSI"
- "INDICATOR_TYPE_MACD"
- "INDICATOR_TYPE_SMA"
type: "string"
GetTechAnalysisRequestSmoothing:
properties:
fastLength:
description: "Короткий период сглаживания для первой экспоненциальной скользящей средней (EMA)."
format: "int32"
type: "integer"
slowLength:
description: "Длинный период сглаживания для второй экспоненциальной скользящей средней (EMA)."
format: "int32"
type: "integer"
signalSmoothing:
format: "int32"
title: "Период сглаживания для третьей экспоненциальной скользящей средней (EMA)"
type: "integer"
type: "object"
GetTechAnalysisRequestTypeOfPrice:
default: "TYPE_OF_PRICE_UNSPECIFIED"
description: " - TYPE_OF_PRICE_UNSPECIFIED: Не указано.\n - TYPE_OF_PRICE_CLOSE: Цена закрытия.\n - TYPE_OF_PRICE_OPEN: Цена открытия.\n - TYPE_OF_PRICE_HIGH: Максимальное значение за выбранный интервал.\n - TYPE_OF_PRICE_LOW: Минимальное значение за выбранный интервал.\n - TYPE_OF_PRICE_AVG: Среднее значение по показателям [ (close + open + high + low) / 4 ]."
enum:
- "TYPE_OF_PRICE_UNSPECIFIED"
- "TYPE_OF_PRICE_CLOSE"
- "TYPE_OF_PRICE_OPEN"
- "TYPE_OF_PRICE_HIGH"
- "TYPE_OF_PRICE_LOW"
- "TYPE_OF_PRICE_AVG"
type: "string"
GetTechAnalysisResponseTechAnalysisItem:
example:
lowerBand:
nano: 6
units: "units"
upperBand:
nano: 6
units: "units"
macd:
nano: 6
units: "units"
signal:
nano: 6
units: "units"
timestamp: 2000-01-23T04:56:07.000Z
middleBand:
nano: 6
units: "units"
properties:
timestamp:
description: "Временная метка по UTC, для которой были рассчитаны значения индикатора."
format: "date-time"
type: "string"
middleBand:
$ref: "#/components/schemas/v1Quotation"
upperBand:
$ref: "#/components/schemas/v1Quotation"
lowerBand:
$ref: "#/components/schemas/v1Quotation"
signal:
$ref: "#/components/schemas/v1Quotation"
macd:
$ref: "#/components/schemas/v1Quotation"
type: "object"
OrderStateStreamResponseMarkerType:
default: "MARKER_UNKNOWN"
description: "- MARKER_UNKNOWN: не определено\n - MARKER_BROKER: сделки брокера\n - MARKER_CHAT: исполнение поручение, полученного от клиента через каналы связи\n - MARKER_PAPER: исполнение поручение, полученного от клиента в бумажной форме\n - MARKER_MARGIN: принудительное закрытие позиций\n - MARKER_TKBNM: сделки по управлению ликвидностью\n - MARKER_SHORT: сделки РЕПО по привлечению у клиентов бумаг\n - MARKER_SPECMM: перенос временно непокрытых позиций"
enum:
- "MARKER_UNKNOWN"
- "MARKER_BROKER"
- "MARKER_CHAT"
- "MARKER_PAPER"
- "MARKER_MARGIN"
- "MARKER_TKBNM"
- "MARKER_SHORT"
- "MARKER_SPECMM"
- "MARKER_PO"
title: "Маркер"
type: "string"
OrderStateStreamResponseStatusCauseInfo:
default: "CAUSE_UNSPECIFIED"
description: "- CAUSE_UNSPECIFIED: Не определено\n - CAUSE_CANCELLED_BY_CLIENT: Отменено клиентом\n - CAUSE_CANCELLED_BY_EXCHANGE: Отменено биржей\n - CAUSE_CANCELLED_NOT_ENOUGH_POSITION: Заявка не выставлена из-за нехватки средств\n - CAUSE_CANCELLED_BY_CLIENT_BLOCK: Отменено из-за блокировки клиента\n - CAUSE_REJECTED_BY_BROKER: Отклонено брокером\n - CAUSE_REJECTED_BY_EXCHANGE: Отклонено биржей\n - CAUSE_CANCELLED_BY_BROKER: Отменено брокером"
enum:
- "CAUSE_UNSPECIFIED"
- "CAUSE_CANCELLED_BY_CLIENT"
- "CAUSE_CANCELLED_BY_EXCHANGE"
- "CAUSE_CANCELLED_NOT_ENOUGH_POSITION"
- "CAUSE_CANCELLED_BY_CLIENT_BLOCK"
- "CAUSE_REJECTED_BY_BROKER"
- "CAUSE_REJECTED_BY_EXCHANGE"
- "CAUSE_CANCELLED_BY_BROKER"
title: "Дополнительная информация по статусу заявки"
type: "string"
PortfolioRequestCurrencyRequest:
default: "RUB"
enum:
- "RUB"
- "USD"
- "EUR"
title: "- RUB: Рубли\n - USD: Доллары\n - EUR: Евро"
type: "string"
RiskRatesResponseRiskRate:
example:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
properties:
riskLevelCode:
description: "Категория риска."
type: "string"
value:
$ref: "#/components/schemas/v1Quotation"
type: "object"
RiskRatesResponseRiskRateResult:
example:
longRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
longRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
error: "error"
properties:
instrumentUid:
type: "string"
shortRiskRate:
$ref: "#/components/schemas/RiskRatesResponseRiskRate"
longRiskRate:
$ref: "#/components/schemas/RiskRatesResponseRiskRate"
shortRiskRates:
items:
$ref: "#/components/schemas/RiskRatesResponseRiskRate"
title: "Доступные ставки риска в шорт"
type: "array"
longRiskRates:
items:
$ref: "#/components/schemas/RiskRatesResponseRiskRate"
title: "Доступные ставки риска в лонг"
type: "array"
error:
description: "Ошибка."
type: "string"
type: "object"
TradingIntervalTimeInterval:
example:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
properties:
startTs:
description: "Время начала интервала."
format: "date-time"
type: "string"
endTs:
description: "Время окончания интервала."
format: "date-time"
type: "string"
type: "object"
contractv1CandleSource:
default: "CANDLE_SOURCE_UNSPECIFIED"
description: " - CANDLE_SOURCE_UNSPECIFIED: Источник свечей не определен.\n - CANDLE_SOURCE_EXCHANGE: Биржевые свечи.\n - CANDLE_SOURCE_DEALER_WEEKEND: Свечи дилера в результате торговли по выходным."
enum:
- "CANDLE_SOURCE_UNSPECIFIED"
- "CANDLE_SOURCE_EXCHANGE"
- "CANDLE_SOURCE_DEALER_WEEKEND"
type: "string"
contractv1OrderState:
description: "Информация о торговом поручении."
example:
orderId: "orderId"
figi: "figi"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
initialCommission:
nano: 5
currency: "currency"
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
lotsExecuted: "lotsExecuted"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
stages:
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
orderRequestId: "orderRequestId"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
executedCommission:
nano: 5
currency: "currency"
units: "units"
initialSecurityPrice:
nano: 5
currency: "currency"
units: "units"
serviceCommission:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
orderDate: 2000-01-23T04:56:07.000Z
properties:
orderId:
description: "Биржевой идентификатор заявки."
type: "string"
executionReportStatus:
$ref: "#/components/schemas/v1OrderExecutionReportStatus"
lotsRequested:
description: "Запрошено лотов."
format: "int64"
type: "string"
lotsExecuted:
description: "Исполнено лотов."
format: "int64"
type: "string"
initialOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
executedOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
totalOrderAmount:
$ref: "#/components/schemas/v1MoneyValue"
averagePositionPrice:
$ref: "#/components/schemas/v1MoneyValue"
initialCommission:
$ref: "#/components/schemas/v1MoneyValue"
executedCommission:
$ref: "#/components/schemas/v1MoneyValue"
figi:
description: "Figi-идентификатор инструмента."
type: "string"
direction:
$ref: "#/components/schemas/v1OrderDirection"
initialSecurityPrice:
$ref: "#/components/schemas/v1MoneyValue"
stages:
description: "Стадии выполнения заявки."
items:
$ref: "#/components/schemas/v1OrderStage"
type: "array"
serviceCommission:
$ref: "#/components/schemas/v1MoneyValue"
currency:
description: "Валюта заявки."
type: "string"
orderType:
$ref: "#/components/schemas/v1OrderType"
orderDate:
description: "Дата и время выставления заявки в часовом поясе UTC."
format: "date-time"
type: "string"
instrumentUid:
description: "UID идентификатор инструмента."
type: "string"
orderRequestId:
description: "Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов."
type: "string"
type: "object"
protobufAny:
additionalProperties:
type: "object"
example:
"@type": "@type"
properties:
"@type":
type: "string"
type: "object"
rpcStatus:
example:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
code:
format: "int32"
type: "integer"
message:
type: "string"
details:
items:
$ref: "#/components/schemas/protobufAny"
type: "array"
type: "object"
v1AccessLevel:
default: "ACCOUNT_ACCESS_LEVEL_UNSPECIFIED"
description: "Уровень доступа к счёту.\n\n - ACCOUNT_ACCESS_LEVEL_UNSPECIFIED: Уровень доступа не определён.\n - ACCOUNT_ACCESS_LEVEL_FULL_ACCESS: Полный доступ к счёту.\n - ACCOUNT_ACCESS_LEVEL_READ_ONLY: Доступ с уровнем прав «только чтение».\n - ACCOUNT_ACCESS_LEVEL_NO_ACCESS: Доступа нет."
enum:
- "ACCOUNT_ACCESS_LEVEL_UNSPECIFIED"
- "ACCOUNT_ACCESS_LEVEL_FULL_ACCESS"
- "ACCOUNT_ACCESS_LEVEL_READ_ONLY"
- "ACCOUNT_ACCESS_LEVEL_NO_ACCESS"
type: "string"
v1Account:
description: "Информация о счёте."
example:
openedDate: 2000-01-23T04:56:07.000Z
closedDate: 2000-01-23T04:56:07.000Z
name: "name"
id: "id"
properties:
id:
description: "Идентификатор счёта."
type: "string"
type:
$ref: "#/components/schemas/v1AccountType"
name:
description: "Название счёта."
type: "string"
status:
$ref: "#/components/schemas/v1AccountStatus"
openedDate:
description: "Дата открытия счёта в часовом поясе UTC."
format: "date-time"
type: "string"
closedDate:
description: "Дата закрытия счёта в часовом поясе UTC."
format: "date-time"
type: "string"
accessLevel:
$ref: "#/components/schemas/v1AccessLevel"
type: "object"
v1AccountStatus:
default: "ACCOUNT_STATUS_UNSPECIFIED"
description: "Статус счёта.\n\n - ACCOUNT_STATUS_UNSPECIFIED: Статус счёта не определён.\n - ACCOUNT_STATUS_NEW: Новый, в процессе открытия.\n - ACCOUNT_STATUS_OPEN: Открытый и активный счёт.\n - ACCOUNT_STATUS_CLOSED: Закрытый счёт.\n - ACCOUNT_STATUS_ALL: Все счета."
enum:
- "ACCOUNT_STATUS_UNSPECIFIED"
- "ACCOUNT_STATUS_NEW"
- "ACCOUNT_STATUS_OPEN"
- "ACCOUNT_STATUS_CLOSED"
- "ACCOUNT_STATUS_ALL"
type: "string"
v1AccountSubscriptionStatus:
description: "Счет клиента."
example:
accountId: "accountId"
properties:
accountId:
description: "Идентификатор счета."
type: "string"
subscriptionStatus:
$ref: "#/components/schemas/v1PortfolioSubscriptionStatus"
type: "object"
v1AccountType:
default: "ACCOUNT_TYPE_UNSPECIFIED"
description: "Тип счёта.\n\n - ACCOUNT_TYPE_UNSPECIFIED: Тип аккаунта не определён.\n - ACCOUNT_TYPE_TINKOFF: Брокерский счёт Т-Инвестиций.\n - ACCOUNT_TYPE_TINKOFF_IIS: ИИС.\n - ACCOUNT_TYPE_INVEST_BOX: Инвесткопилка.\n - ACCOUNT_TYPE_INVEST_FUND: Фонд денежного рынка."
enum:
- "ACCOUNT_TYPE_UNSPECIFIED"
- "ACCOUNT_TYPE_TINKOFF"
- "ACCOUNT_TYPE_TINKOFF_IIS"
- "ACCOUNT_TYPE_INVEST_BOX"
- "ACCOUNT_TYPE_INVEST_FUND"
type: "string"
v1AccruedInterest:
description: "Операция начисления купонов."
example:
date: 2000-01-23T04:56:07.000Z
valuePercent:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
value:
nano: 6
units: "units"
properties:
date:
description: "Дата и время выплаты по UTC."
format: "date-time"
type: "string"
value:
$ref: "#/components/schemas/v1Quotation"
valuePercent:
$ref: "#/components/schemas/v1Quotation"
nominal:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1Asset:
description: "Информация об активе."
example:
uid: "uid"
instruments:
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
name: "name"
properties:
uid:
description: "Уникальный идентификатор актива."
type: "string"
type:
$ref: "#/components/schemas/v1AssetType"
name:
description: "Наименование актива."
type: "string"
instruments:
description: "Массив идентификаторов инструментов."
items:
$ref: "#/components/schemas/v1AssetInstrument"
type: "array"
type: "object"
v1AssetBond:
description: "Облигация."
example:
indexedNominalFlag: true
couponQuantityPerYear: 0
currentNominal:
nano: 6
units: "units"
taxFreeFlag: true
returnCondition: "returnCondition"
collateralFlag: true
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
amortizationFlag: true
perpetualFlag: true
maturityDate: 2000-01-23T04:56:07.000Z
issueSize:
nano: 6
units: "units"
interestKind: "interestKind"
subordinatedFlag: true
nominalCurrency: "nominalCurrency"
floatingCouponFlag: true
placementPrice:
nano: 6
units: "units"
properties:
currentNominal:
$ref: "#/components/schemas/v1Quotation"
borrowName:
description: "Наименование заемщика."
type: "string"
issueSize:
$ref: "#/components/schemas/v1Quotation"
nominal:
$ref: "#/components/schemas/v1Quotation"
nominalCurrency:
description: "Валюта номинала."
type: "string"
issueKind:
description: "Форма выпуска облигации."
type: "string"
interestKind:
description: "Форма дохода облигации."
type: "string"
couponQuantityPerYear:
description: "Количество выплат в год."
format: "int32"
type: "integer"
indexedNominalFlag:
description: "Признак облигации с индексируемым номиналом."
type: "boolean"
subordinatedFlag:
description: "Признак субординированной облигации."
type: "boolean"
collateralFlag:
description: "Признак обеспеченной облигации."
type: "boolean"
taxFreeFlag:
description: "Признак показывает, что купоны облигации не облагаются налогом — для mass market."
type: "boolean"
amortizationFlag:
description: "Признак облигации с амортизацией долга."
type: "boolean"
floatingCouponFlag:
description: "Признак облигации с плавающим купоном."
type: "boolean"
perpetualFlag:
description: "Признак бессрочной облигации."
type: "boolean"
maturityDate:
description: "Дата погашения облигации."
format: "date-time"
type: "string"
returnCondition:
description: "Описание и условия получения дополнительного дохода."
type: "string"
stateRegDate:
description: "Дата выпуска облигации."
format: "date-time"
type: "string"
placementDate:
description: "Дата размещения облигации."
format: "date-time"
type: "string"
placementPrice:
$ref: "#/components/schemas/v1Quotation"
issueSizePlan:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1AssetClearingCertificate:
description: "Клиринговый сертификат участия."
example:
nominal:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
properties:
nominal:
$ref: "#/components/schemas/v1Quotation"
nominalCurrency:
description: "Валюта номинала."
type: "string"
type: "object"
v1AssetCurrency:
description: "Валюта."
example:
baseCurrency: "baseCurrency"
properties:
baseCurrency:
description: "ISO-код валюты."
type: "string"
type: "object"
v1AssetEtf:
description: "Фонд."
example:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
numShare:
nano: 6
units: "units"
watermarkFlag: true
description: "description"
primaryIndexCompany: "primaryIndexCompany"
inavCode: "inavCode"
indexRecoveryPeriod:
nano: 6
units: "units"
performanceFee:
nano: 6
units: "units"
paymentType: "paymentType"
managementType: "managementType"
primaryIndexTrackingError:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
ucitsFlag: true
expenseCommission:
nano: 6
units: "units"
focusType: "focusType"
primaryIndexDescription: "primaryIndexDescription"
rebalancingPlan: "rebalancingPlan"
hurdleRate:
nano: 6
units: "units"
primaryIndex: "primaryIndex"
leveragedFlag: true
taxRate: "taxRate"
issueKind: "issueKind"
sellDiscount:
nano: 6
units: "units"
rebalancingDates:
- 2000-01-23T04:56:07.000Z
- 2000-01-23T04:56:07.000Z
rebalancingFreq: "rebalancingFreq"
rebalancingFlag: true
nominalCurrency: "nominalCurrency"
divYieldFlag: true
totalExpense:
nano: 6
units: "units"
buyPremium:
nano: 6
units: "units"
properties:
totalExpense:
$ref: "#/components/schemas/v1Quotation"
hurdleRate:
$ref: "#/components/schemas/v1Quotation"
performanceFee:
$ref: "#/components/schemas/v1Quotation"
fixedCommission:
$ref: "#/components/schemas/v1Quotation"
paymentType:
description: "Тип распределения доходов от выплат по бумагам."
type: "string"
watermarkFlag:
description: "Признак необходимости выхода фонда в плюс для получения комиссии."
type: "boolean"
buyPremium:
$ref: "#/components/schemas/v1Quotation"
sellDiscount:
$ref: "#/components/schemas/v1Quotation"
rebalancingFlag:
description: "Признак ребалансируемости портфеля фонда."
type: "boolean"
rebalancingFreq:
description: "Периодичность ребалансировки."
type: "string"
managementType:
description: "Тип управления."
type: "string"
primaryIndex:
description: "Индекс, который реплицирует (старается копировать) фонд."
type: "string"
focusType:
description: "База ETF."
type: "string"
leveragedFlag:
description: "Признак использования заемных активов (плечо)."
type: "boolean"
numShare:
$ref: "#/components/schemas/v1Quotation"
ucitsFlag:
description: "Признак обязательства по отчетности перед регулятором."
type: "boolean"
releasedDate:
description: "Дата выпуска."
format: "date-time"
type: "string"
description:
description: "Описание фонда."
type: "string"
primaryIndexDescription:
description: "Описание индекса, за которым следует фонд."
type: "string"
primaryIndexCompany:
description: "Основные компании, в которые вкладывается фонд."
type: "string"
indexRecoveryPeriod:
$ref: "#/components/schemas/v1Quotation"
inavCode:
description: "IVAV-код."
type: "string"
divYieldFlag:
description: "Признак наличия дивидендной доходности."
type: "boolean"
expenseCommission:
$ref: "#/components/schemas/v1Quotation"
primaryIndexTrackingError:
$ref: "#/components/schemas/v1Quotation"
rebalancingPlan:
description: "Плановая ребалансировка портфеля."
type: "string"
taxRate:
description: "Ставки налогообложения дивидендов и купонов."
type: "string"
rebalancingDates:
description: "Даты ребалансировок."
items:
format: "date-time"
type: "string"
type: "array"
issueKind:
description: "Форма выпуска."
type: "string"
nominal:
$ref: "#/components/schemas/v1Quotation"
nominalCurrency:
description: "Валюта номинала."
type: "string"
type: "object"
v1AssetFull:
example:
cfi: "cfi"
description: "description"
uid: "uid"
requiredTests:
- "requiredTests"
- "requiredTests"
codeNsd: "codeNsd"
deletedAt: 2000-01-23T04:56:07.000Z
security:
etf:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
numShare:
nano: 6
units: "units"
watermarkFlag: true
description: "description"
primaryIndexCompany: "primaryIndexCompany"
inavCode: "inavCode"
indexRecoveryPeriod:
nano: 6
units: "units"
performanceFee:
nano: 6
units: "units"
paymentType: "paymentType"
managementType: "managementType"
primaryIndexTrackingError:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
ucitsFlag: true
expenseCommission:
nano: 6
units: "units"
focusType: "focusType"
primaryIndexDescription: "primaryIndexDescription"
rebalancingPlan: "rebalancingPlan"
hurdleRate:
nano: 6
units: "units"
primaryIndex: "primaryIndex"
leveragedFlag: true
taxRate: "taxRate"
issueKind: "issueKind"
sellDiscount:
nano: 6
units: "units"
rebalancingDates:
- 2000-01-23T04:56:07.000Z
- 2000-01-23T04:56:07.000Z
rebalancingFreq: "rebalancingFreq"
rebalancingFlag: true
nominalCurrency: "nominalCurrency"
divYieldFlag: true
totalExpense:
nano: 6
units: "units"
buyPremium:
nano: 6
units: "units"
clearingCertificate:
nominal:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
share:
totalFloat:
nano: 6
units: "units"
dividendRate:
nano: 6
units: "units"
registryDate: 2000-01-23T04:56:07.000Z
primaryIndex: "primaryIndex"
preferredShareType: "preferredShareType"
issueSizePlan:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
divYieldFlag: true
represIsin: "represIsin"
ipoDate: 2000-01-23T04:56:07.000Z
type: "type"
bond:
indexedNominalFlag: true
couponQuantityPerYear: 0
currentNominal:
nano: 6
units: "units"
taxFreeFlag: true
returnCondition: "returnCondition"
collateralFlag: true
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
amortizationFlag: true
perpetualFlag: true
maturityDate: 2000-01-23T04:56:07.000Z
issueSize:
nano: 6
units: "units"
interestKind: "interestKind"
subordinatedFlag: true
nominalCurrency: "nominalCurrency"
floatingCouponFlag: true
placementPrice:
nano: 6
units: "units"
sp:
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
logicPortfolio: "logicPortfolio"
safetyBarrier:
nano: 6
units: "units"
basicAsset: "basicAsset"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
isin: "isin"
instruments:
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
gosRegCode: "gosRegCode"
name: "name"
brCodeName: "brCodeName"
currency:
baseCurrency: "baseCurrency"
brCode: "brCode"
brand:
uid: "uid"
name: "name"
description: "description"
company: "company"
sector: "sector"
countryOfRiskName: "countryOfRiskName"
info: "info"
countryOfRisk: "countryOfRisk"
nameBrief: "nameBrief"
status: "status"
updatedAt: 2000-01-23T04:56:07.000Z
properties:
uid:
description: "Уникальный идентификатор актива."
type: "string"
type:
$ref: "#/components/schemas/v1AssetType"
name:
description: "Наименование актива."
type: "string"
nameBrief:
description: "Короткое наименование актива."
type: "string"
description:
description: "Описание актива."
type: "string"
deletedAt:
description: "Дата и время удаления актива."
format: "date-time"
type: "string"
requiredTests:
description: "Тестирование клиентов."
items:
type: "string"
type: "array"
currency:
$ref: "#/components/schemas/v1AssetCurrency"
security:
$ref: "#/components/schemas/v1AssetSecurity"
gosRegCode:
description: "Номер государственной регистрации."
type: "string"
cfi:
description: "Код CFI."
type: "string"
codeNsd:
description: "Код НРД инструмента."
type: "string"
status:
description: "Статус актива."
type: "string"
brand:
$ref: "#/components/schemas/v1Brand"
updatedAt:
description: "Дата и время последнего обновления записи."
format: "date-time"
type: "string"
brCode:
description: "Код типа ц.б. по классификации Банка России."
type: "string"
brCodeName:
description: "Наименование кода типа ц.б. по классификации Банка России."
type: "string"
instruments:
description: "Массив идентификаторов инструментов."
items:
$ref: "#/components/schemas/v1AssetInstrument"
type: "array"
type: "object"
v1AssetInstrument:
description: "Идентификаторы инструмента."
example:
uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
properties:
uid:
description: "UID-идентификатор инструмента."
type: "string"
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
links:
description: "Массив связанных инструментов."
items:
$ref: "#/components/schemas/v1InstrumentLink"
type: "array"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
positionUid:
description: "ID позиции."
type: "string"
type: "object"
v1AssetRequest:
description: "Запрос актива по идентификатору."
properties:
id:
description: "UID-идентификатор актива."
type: "string"
required:
- "id"
type: "object"
v1AssetResponse:
description: "Данные по активу."
example:
asset:
cfi: "cfi"
description: "description"
uid: "uid"
requiredTests:
- "requiredTests"
- "requiredTests"
codeNsd: "codeNsd"
deletedAt: 2000-01-23T04:56:07.000Z
security:
etf:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
numShare:
nano: 6
units: "units"
watermarkFlag: true
description: "description"
primaryIndexCompany: "primaryIndexCompany"
inavCode: "inavCode"
indexRecoveryPeriod:
nano: 6
units: "units"
performanceFee:
nano: 6
units: "units"
paymentType: "paymentType"
managementType: "managementType"
primaryIndexTrackingError:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
ucitsFlag: true
expenseCommission:
nano: 6
units: "units"
focusType: "focusType"
primaryIndexDescription: "primaryIndexDescription"
rebalancingPlan: "rebalancingPlan"
hurdleRate:
nano: 6
units: "units"
primaryIndex: "primaryIndex"
leveragedFlag: true
taxRate: "taxRate"
issueKind: "issueKind"
sellDiscount:
nano: 6
units: "units"
rebalancingDates:
- 2000-01-23T04:56:07.000Z
- 2000-01-23T04:56:07.000Z
rebalancingFreq: "rebalancingFreq"
rebalancingFlag: true
nominalCurrency: "nominalCurrency"
divYieldFlag: true
totalExpense:
nano: 6
units: "units"
buyPremium:
nano: 6
units: "units"
clearingCertificate:
nominal:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
share:
totalFloat:
nano: 6
units: "units"
dividendRate:
nano: 6
units: "units"
registryDate: 2000-01-23T04:56:07.000Z
primaryIndex: "primaryIndex"
preferredShareType: "preferredShareType"
issueSizePlan:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
divYieldFlag: true
represIsin: "represIsin"
ipoDate: 2000-01-23T04:56:07.000Z
type: "type"
bond:
indexedNominalFlag: true
couponQuantityPerYear: 0
currentNominal:
nano: 6
units: "units"
taxFreeFlag: true
returnCondition: "returnCondition"
collateralFlag: true
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
amortizationFlag: true
perpetualFlag: true
maturityDate: 2000-01-23T04:56:07.000Z
issueSize:
nano: 6
units: "units"
interestKind: "interestKind"
subordinatedFlag: true
nominalCurrency: "nominalCurrency"
floatingCouponFlag: true
placementPrice:
nano: 6
units: "units"
sp:
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
logicPortfolio: "logicPortfolio"
safetyBarrier:
nano: 6
units: "units"
basicAsset: "basicAsset"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
isin: "isin"
instruments:
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
gosRegCode: "gosRegCode"
name: "name"
brCodeName: "brCodeName"
currency:
baseCurrency: "baseCurrency"
brCode: "brCode"
brand:
uid: "uid"
name: "name"
description: "description"
company: "company"
sector: "sector"
countryOfRiskName: "countryOfRiskName"
info: "info"
countryOfRisk: "countryOfRisk"
nameBrief: "nameBrief"
status: "status"
updatedAt: 2000-01-23T04:56:07.000Z
properties:
asset:
$ref: "#/components/schemas/v1AssetFull"
type: "object"
v1AssetSecurity:
description: "Ценная бумага."
example:
etf:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
numShare:
nano: 6
units: "units"
watermarkFlag: true
description: "description"
primaryIndexCompany: "primaryIndexCompany"
inavCode: "inavCode"
indexRecoveryPeriod:
nano: 6
units: "units"
performanceFee:
nano: 6
units: "units"
paymentType: "paymentType"
managementType: "managementType"
primaryIndexTrackingError:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
ucitsFlag: true
expenseCommission:
nano: 6
units: "units"
focusType: "focusType"
primaryIndexDescription: "primaryIndexDescription"
rebalancingPlan: "rebalancingPlan"
hurdleRate:
nano: 6
units: "units"
primaryIndex: "primaryIndex"
leveragedFlag: true
taxRate: "taxRate"
issueKind: "issueKind"
sellDiscount:
nano: 6
units: "units"
rebalancingDates:
- 2000-01-23T04:56:07.000Z
- 2000-01-23T04:56:07.000Z
rebalancingFreq: "rebalancingFreq"
rebalancingFlag: true
nominalCurrency: "nominalCurrency"
divYieldFlag: true
totalExpense:
nano: 6
units: "units"
buyPremium:
nano: 6
units: "units"
clearingCertificate:
nominal:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
share:
totalFloat:
nano: 6
units: "units"
dividendRate:
nano: 6
units: "units"
registryDate: 2000-01-23T04:56:07.000Z
primaryIndex: "primaryIndex"
preferredShareType: "preferredShareType"
issueSizePlan:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
divYieldFlag: true
represIsin: "represIsin"
ipoDate: 2000-01-23T04:56:07.000Z
type: "type"
bond:
indexedNominalFlag: true
couponQuantityPerYear: 0
currentNominal:
nano: 6
units: "units"
taxFreeFlag: true
returnCondition: "returnCondition"
collateralFlag: true
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
amortizationFlag: true
perpetualFlag: true
maturityDate: 2000-01-23T04:56:07.000Z
issueSize:
nano: 6
units: "units"
interestKind: "interestKind"
subordinatedFlag: true
nominalCurrency: "nominalCurrency"
floatingCouponFlag: true
placementPrice:
nano: 6
units: "units"
sp:
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
logicPortfolio: "logicPortfolio"
safetyBarrier:
nano: 6
units: "units"
basicAsset: "basicAsset"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
isin: "isin"
properties:
isin:
description: "ISIN-идентификатор ценной бумаги."
type: "string"
type:
description: "Тип ценной бумаги."
type: "string"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
share:
$ref: "#/components/schemas/v1AssetShare"
bond:
$ref: "#/components/schemas/v1AssetBond"
sp:
$ref: "#/components/schemas/v1AssetStructuredProduct"
etf:
$ref: "#/components/schemas/v1AssetEtf"
clearingCertificate:
$ref: "#/components/schemas/v1AssetClearingCertificate"
type: "object"
v1AssetShare:
description: "Акция."
example:
totalFloat:
nano: 6
units: "units"
dividendRate:
nano: 6
units: "units"
registryDate: 2000-01-23T04:56:07.000Z
primaryIndex: "primaryIndex"
preferredShareType: "preferredShareType"
issueSizePlan:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
divYieldFlag: true
represIsin: "represIsin"
ipoDate: 2000-01-23T04:56:07.000Z
properties:
type:
$ref: "#/components/schemas/v1ShareType"
issueSize:
$ref: "#/components/schemas/v1Quotation"
nominal:
$ref: "#/components/schemas/v1Quotation"
nominalCurrency:
description: "Валюта номинала."
type: "string"
primaryIndex:
description: "Индекс (Bloomberg)."
type: "string"
dividendRate:
$ref: "#/components/schemas/v1Quotation"
preferredShareType:
description: "Тип привилегированных акций."
type: "string"
ipoDate:
description: "Дата IPO."
format: "date-time"
type: "string"
registryDate:
description: "Дата регистрации."
format: "date-time"
type: "string"
divYieldFlag:
description: "Признак наличия дивидендной доходности."
type: "boolean"
issueKind:
description: "Форма выпуска ФИ."
type: "string"
placementDate:
description: "Дата размещения акции."
format: "date-time"
type: "string"
represIsin:
description: "ISIN базового актива."
type: "string"
issueSizePlan:
$ref: "#/components/schemas/v1Quotation"
totalFloat:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1AssetStructuredProduct:
description: "Структурная нота."
example:
issueSizePlan:
nano: 6
units: "units"
borrowName: "borrowName"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
nominal:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
logicPortfolio: "logicPortfolio"
safetyBarrier:
nano: 6
units: "units"
basicAsset: "basicAsset"
issueSize:
nano: 6
units: "units"
nominalCurrency: "nominalCurrency"
properties:
borrowName:
description: "Наименование заемщика."
type: "string"
nominal:
$ref: "#/components/schemas/v1Quotation"
nominalCurrency:
description: "Валюта номинала."
type: "string"
type:
$ref: "#/components/schemas/v1StructuredProductType"
logicPortfolio:
description: "Стратегия портфеля."
type: "string"
assetType:
$ref: "#/components/schemas/v1AssetType"
basicAsset:
description: "Вид базового актива в зависимости от типа базового актива."
type: "string"
safetyBarrier:
$ref: "#/components/schemas/v1Quotation"
maturityDate:
description: "Дата погашения."
format: "date-time"
type: "string"
issueSizePlan:
$ref: "#/components/schemas/v1Quotation"
issueSize:
$ref: "#/components/schemas/v1Quotation"
placementDate:
description: "Дата размещения ноты."
format: "date-time"
type: "string"
issueKind:
description: "Форма выпуска."
type: "string"
type: "object"
v1AssetType:
default: "ASSET_TYPE_UNSPECIFIED"
description: "Тип актива.\n\n - ASSET_TYPE_UNSPECIFIED: Тип не определен.\n - ASSET_TYPE_CURRENCY: Валюта.\n - ASSET_TYPE_COMMODITY: Товар.\n - ASSET_TYPE_INDEX: Индекс.\n - ASSET_TYPE_SECURITY: Ценная бумага."
enum:
- "ASSET_TYPE_UNSPECIFIED"
- "ASSET_TYPE_CURRENCY"
- "ASSET_TYPE_COMMODITY"
- "ASSET_TYPE_INDEX"
- "ASSET_TYPE_SECURITY"
type: "string"
v1AssetsRequest:
description: "Запрос списка активов."
properties:
instrumentType:
$ref: "#/components/schemas/v1InstrumentType"
instrumentStatus:
$ref: "#/components/schemas/v1InstrumentStatus"
type: "object"
v1AssetsResponse:
description: "Список активов."
example:
assets:
- uid: "uid"
instruments:
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
name: "name"
- uid: "uid"
instruments:
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
- uid: "uid"
classCode: "classCode"
instrumentType: "instrumentType"
ticker: "ticker"
positionUid: "positionUid"
figi: "figi"
links:
- instrumentUid: "instrumentUid"
type: "type"
- instrumentUid: "instrumentUid"
type: "type"
name: "name"
properties:
assets:
description: "Активы."
items:
$ref: "#/components/schemas/v1Asset"
type: "array"
type: "object"
v1Bond:
description: "Объект передачи информации об облигации."
example:
assetUid: "assetUid"
callDate: 2000-01-23T04:56:07.000Z
countryOfRisk: "countryOfRisk"
blockedTcaFlag: true
dlongClient:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
first1dayCandleDate: 2000-01-23T04:56:07.000Z
placementPrice:
nano: 5
currency: "currency"
units: "units"
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
shortEnabledFlag: true
dshortClient:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
subordinatedFlag: true
floatingCouponFlag: true
figi: "figi"
dshortMin:
nano: 6
units: "units"
lot: 0
uid: "uid"
dlong:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
aciValue:
nano: 5
currency: "currency"
units: "units"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
couponQuantityPerYear: 1
forQualInvestorFlag: true
initialNominal:
nano: 5
currency: "currency"
units: "units"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
amortizationFlag: true
perpetualFlag: true
issueSize: "issueSize"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
lot:
description: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)."
format: "int32"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций в шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
couponQuantityPerYear:
description: "Количество выплат по купонам в год."
format: "int32"
type: "integer"
maturityDate:
description: "Дата погашения облигации по UTC."
format: "date-time"
type: "string"
nominal:
$ref: "#/components/schemas/v1MoneyValue"
initialNominal:
$ref: "#/components/schemas/v1MoneyValue"
stateRegDate:
description: "Дата выпуска облигации по UTC."
format: "date-time"
type: "string"
placementDate:
description: "Дата размещения по UTC."
format: "date-time"
type: "string"
placementPrice:
$ref: "#/components/schemas/v1MoneyValue"
aciValue:
$ref: "#/components/schemas/v1MoneyValue"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
sector:
description: "Сектор экономики."
type: "string"
issueKind:
description: "Форма выпуска. Возможные значения: <br/>**documentary** — документарная; <br/>**non_documentary** — бездокументарная."
type: "string"
issueSize:
description: "Размер выпуска."
format: "int64"
type: "string"
issueSizePlan:
description: "Плановый размер выпуска."
format: "int64"
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
floatingCouponFlag:
description: "Признак облигации с плавающим купоном."
type: "boolean"
perpetualFlag:
description: "Признак бессрочной облигации."
type: "boolean"
amortizationFlag:
description: "Признак облигации с амортизацией долга."
type: "boolean"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Параметр указывает на возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
assetUid:
description: "Уникальный идентификатор актива."
type: "string"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
subordinatedFlag:
description: "Признак субординированной облигации."
type: "boolean"
liquidityFlag:
description: "Флаг достаточной ликвидности."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
riskLevel:
$ref: "#/components/schemas/v1RiskLevel"
brand:
$ref: "#/components/schemas/v1BrandData"
bondType:
$ref: "#/components/schemas/v1BondType"
callDate:
description: "Дата погашения облигации."
format: "date-time"
type: "string"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1BondResponse:
description: "Информация об облигации."
example:
instrument:
assetUid: "assetUid"
callDate: 2000-01-23T04:56:07.000Z
countryOfRisk: "countryOfRisk"
blockedTcaFlag: true
dlongClient:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
first1dayCandleDate: 2000-01-23T04:56:07.000Z
placementPrice:
nano: 5
currency: "currency"
units: "units"
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
shortEnabledFlag: true
dshortClient:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
subordinatedFlag: true
floatingCouponFlag: true
figi: "figi"
dshortMin:
nano: 6
units: "units"
lot: 0
uid: "uid"
dlong:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
aciValue:
nano: 5
currency: "currency"
units: "units"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
couponQuantityPerYear: 1
forQualInvestorFlag: true
initialNominal:
nano: 5
currency: "currency"
units: "units"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
amortizationFlag: true
perpetualFlag: true
issueSize: "issueSize"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instrument:
$ref: "#/components/schemas/v1Bond"
type: "object"
v1BondType:
default: "BOND_TYPE_UNSPECIFIED"
description: " - BOND_TYPE_UNSPECIFIED: Тип облигации не определен.\n - BOND_TYPE_REPLACED: Замещающая облигация."
enum:
- "BOND_TYPE_UNSPECIFIED"
- "BOND_TYPE_REPLACED"
type: "string"
v1BondsResponse:
description: "Список облигаций."
example:
instruments:
- assetUid: "assetUid"
callDate: 2000-01-23T04:56:07.000Z
countryOfRisk: "countryOfRisk"
blockedTcaFlag: true
dlongClient:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
first1dayCandleDate: 2000-01-23T04:56:07.000Z
placementPrice:
nano: 5
currency: "currency"
units: "units"
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
shortEnabledFlag: true
dshortClient:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
subordinatedFlag: true
floatingCouponFlag: true
figi: "figi"
dshortMin:
nano: 6
units: "units"
lot: 0
uid: "uid"
dlong:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
aciValue:
nano: 5
currency: "currency"
units: "units"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
couponQuantityPerYear: 1
forQualInvestorFlag: true
initialNominal:
nano: 5
currency: "currency"
units: "units"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
amortizationFlag: true
perpetualFlag: true
issueSize: "issueSize"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
- assetUid: "assetUid"
callDate: 2000-01-23T04:56:07.000Z
countryOfRisk: "countryOfRisk"
blockedTcaFlag: true
dlongClient:
nano: 6
units: "units"
maturityDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
first1dayCandleDate: 2000-01-23T04:56:07.000Z
placementPrice:
nano: 5
currency: "currency"
units: "units"
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
shortEnabledFlag: true
dshortClient:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
subordinatedFlag: true
floatingCouponFlag: true
figi: "figi"
dshortMin:
nano: 6
units: "units"
lot: 0
uid: "uid"
dlong:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
aciValue:
nano: 5
currency: "currency"
units: "units"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
couponQuantityPerYear: 1
forQualInvestorFlag: true
initialNominal:
nano: 5
currency: "currency"
units: "units"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
stateRegDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
issueKind: "issueKind"
placementDate: 2000-01-23T04:56:07.000Z
amortizationFlag: true
perpetualFlag: true
issueSize: "issueSize"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instruments:
description: "Массив облигаций."
items:
$ref: "#/components/schemas/v1Bond"
type: "array"
type: "object"
v1Brand:
description: "Бренд."
example:
uid: "uid"
name: "name"
description: "description"
company: "company"
sector: "sector"
countryOfRiskName: "countryOfRiskName"
info: "info"
countryOfRisk: "countryOfRisk"
properties:
uid:
description: "UID-идентификатор бренда."
type: "string"
name:
description: "Наименование бренда."
type: "string"
description:
description: "Описание."
type: "string"
info:
description: "Информация о бренде."
type: "string"
company:
description: "Компания."
type: "string"
sector:
description: "Сектор."
type: "string"
countryOfRisk:
description: "Код страны риска."
type: "string"
countryOfRiskName:
description: "Наименование страны риска."
type: "string"
type: "object"
v1BrandData:
example:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
properties:
logoName:
description: "Логотип инструмента. Имя файла для получения логотипа."
type: "string"
logoBaseColor:
description: "Цвет бренда."
type: "string"
textColor:
description: "Цвет текста для цвета логотипа бренда."
type: "string"
type: "object"
v1BrokerReport:
example:
exchangeClearingCommission:
nano: 5
currency: "currency"
units: "units"
separateAgreementDate: "separateAgreementDate"
orderId: "orderId"
figi: "figi"
executeSign: "executeSign"
brokerCommission:
nano: 5
currency: "currency"
units: "units"
repoRate:
nano: 6
units: "units"
orderAmount:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 6
units: "units"
secValueDate: 2000-01-23T04:56:07.000Z
direction: "direction"
classCode: "classCode"
ticker: "ticker"
quantity: "quantity"
deliveryType: "deliveryType"
tradeDatetime: 2000-01-23T04:56:07.000Z
exchangeCommission:
nano: 5
currency: "currency"
units: "units"
brokerStatus: "brokerStatus"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
separateAgreementNumber: "separateAgreementNumber"
clearValueDate: 2000-01-23T04:56:07.000Z
name: "name"
exchange: "exchange"
separateAgreementType: "separateAgreementType"
tradeId: "tradeId"
party: "party"
properties:
tradeId:
description: "Номер сделки."
type: "string"
orderId:
description: "Номер поручения."
type: "string"
figi:
description: "FIGI-идентификаторинструмента."
type: "string"
executeSign:
description: "Признак исполнения."
type: "string"
tradeDatetime:
description: "Дата и время заключения по UTC."
format: "date-time"
type: "string"
exchange:
description: "Торговая площадка."
type: "string"
classCode:
description: "Режим торгов."
type: "string"
direction:
description: "Вид сделки."
type: "string"
name:
description: "Сокращенное наименование актива."
type: "string"
ticker:
description: "Код актива."
type: "string"
price:
$ref: "#/components/schemas/v1MoneyValue"
quantity:
description: "Количество."
format: "int64"
type: "string"
orderAmount:
$ref: "#/components/schemas/v1MoneyValue"
aciValue:
$ref: "#/components/schemas/v1Quotation"
totalOrderAmount:
$ref: "#/components/schemas/v1MoneyValue"
brokerCommission:
$ref: "#/components/schemas/v1MoneyValue"
exchangeCommission:
$ref: "#/components/schemas/v1MoneyValue"
exchangeClearingCommission:
$ref: "#/components/schemas/v1MoneyValue"
repoRate:
$ref: "#/components/schemas/v1Quotation"
party:
description: "Контрагент или брокерарокер."
type: "string"
clearValueDate:
description: "Дата расчетов по UTC."
format: "date-time"
type: "string"
secValueDate:
description: "Дата поставки по UTC."
format: "date-time"
type: "string"
brokerStatus:
description: "Статус брокера."
type: "string"
separateAgreementType:
description: "Тип договора."
type: "string"
separateAgreementNumber:
description: "Номер договора."
type: "string"
separateAgreementDate:
description: "Дата договора."
type: "string"
deliveryType:
description: "Тип расчета по сделке."
type: "string"
type: "object"
v1BrokerReportRequest:
properties:
generateBrokerReportRequest:
$ref: "#/components/schemas/v1GenerateBrokerReportRequest"
getBrokerReportRequest:
$ref: "#/components/schemas/v1GetBrokerReportRequest"
type: "object"
v1BrokerReportResponse:
example:
generateBrokerReportResponse:
taskId: "taskId"
getBrokerReportResponse:
brokerReport:
- exchangeClearingCommission:
nano: 5
currency: "currency"
units: "units"
separateAgreementDate: "separateAgreementDate"
orderId: "orderId"
figi: "figi"
executeSign: "executeSign"
brokerCommission:
nano: 5
currency: "currency"
units: "units"
repoRate:
nano: 6
units: "units"
orderAmount:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 6
units: "units"
secValueDate: 2000-01-23T04:56:07.000Z
direction: "direction"
classCode: "classCode"
ticker: "ticker"
quantity: "quantity"
deliveryType: "deliveryType"
tradeDatetime: 2000-01-23T04:56:07.000Z
exchangeCommission:
nano: 5
currency: "currency"
units: "units"
brokerStatus: "brokerStatus"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
separateAgreementNumber: "separateAgreementNumber"
clearValueDate: 2000-01-23T04:56:07.000Z
name: "name"
exchange: "exchange"
separateAgreementType: "separateAgreementType"
tradeId: "tradeId"
party: "party"
- exchangeClearingCommission:
nano: 5
currency: "currency"
units: "units"
separateAgreementDate: "separateAgreementDate"
orderId: "orderId"
figi: "figi"
executeSign: "executeSign"
brokerCommission:
nano: 5
currency: "currency"
units: "units"
repoRate:
nano: 6
units: "units"
orderAmount:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 6
units: "units"
secValueDate: 2000-01-23T04:56:07.000Z
direction: "direction"
classCode: "classCode"
ticker: "ticker"
quantity: "quantity"
deliveryType: "deliveryType"
tradeDatetime: 2000-01-23T04:56:07.000Z
exchangeCommission:
nano: 5
currency: "currency"
units: "units"
brokerStatus: "brokerStatus"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
separateAgreementNumber: "separateAgreementNumber"
clearValueDate: 2000-01-23T04:56:07.000Z
name: "name"
exchange: "exchange"
separateAgreementType: "separateAgreementType"
tradeId: "tradeId"
party: "party"
pagesCount: 6
page: 1
itemsCount: 0
properties:
generateBrokerReportResponse:
$ref: "#/components/schemas/v1GenerateBrokerReportResponse"
getBrokerReportResponse:
$ref: "#/components/schemas/v1GetBrokerReportResponse"
type: "object"
v1CancelOrderRequest:
description: "Запрос отмены торгового поручения."
properties:
accountId:
description: "Номер счета."
type: "string"
orderId:
description: "Идентификатор заявки."
type: "string"
orderIdType:
$ref: "#/components/schemas/v1OrderIdType"
required:
- "accountId"
- "orderId"
type: "object"
v1CancelOrderResponse:
description: "Результат отмены торгового поручения."
example:
time: 2000-01-23T04:56:07.000Z
responseMetadata:
serverTime: 2000-01-23T04:56:07.000Z
trackingId: "trackingId"
properties:
time:
description: "Дата и время отмены заявки в часовом поясе UTC."
format: "date-time"
type: "string"
responseMetadata:
$ref: "#/components/schemas/v1ResponseMetadata"
type: "object"
v1CancelStopOrderRequest:
description: "Запрос отмены выставленной стоп-заявки."
properties:
accountId:
description: "Идентификатор счета клиента."
type: "string"
stopOrderId:
description: "Уникальный идентификатор стоп-заявки."
type: "string"
required:
- "accountId"
- "stopOrderId"
type: "object"
v1CancelStopOrderResponse:
description: "Результат отмены выставленной стоп-заявки."
example:
time: 2000-01-23T04:56:07.000Z
properties:
time:
description: "Время отмены заявки по UTC."
format: "date-time"
type: "string"
type: "object"
v1Candle:
description: "Пакет свечей в рамках стрима."
example:
volume: "volume"
high:
nano: 6
units: "units"
lastTradeTs: 2000-01-23T04:56:07.000Z
low:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
interval:
$ref: "#/components/schemas/v1SubscriptionInterval"
open:
$ref: "#/components/schemas/v1Quotation"
high:
$ref: "#/components/schemas/v1Quotation"
low:
$ref: "#/components/schemas/v1Quotation"
close:
$ref: "#/components/schemas/v1Quotation"
volume:
description: "Объем сделок в лотах."
format: "int64"
type: "string"
time:
description: "Время начала интервала свечи по UTC."
format: "date-time"
type: "string"
lastTradeTs:
description: "Время последней сделки, вошедшей в свечу по UTC."
format: "date-time"
type: "string"
instrumentUid:
description: "UID инструмента."
type: "string"
candleSourceType:
$ref: "#/components/schemas/contractv1CandleSource"
type: "object"
v1CandleInstrument:
description: "Запрос изменения статус подписки на свечи."
properties:
figi:
description: "Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`."
type: "string"
deprecated: true
interval:
$ref: "#/components/schemas/v1SubscriptionInterval"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1CandleInterval:
default: "CANDLE_INTERVAL_UNSPECIFIED"
description: "Интервал свечей. Максимальное значение интервала приведено ориентировочно, может отличаться в большую сторону в зависимости от параметров запроса.\n\n - CANDLE_INTERVAL_UNSPECIFIED: Интервал не определен.\n - CANDLE_INTERVAL_1_MIN: От 1 минуты до 1 дня. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_5_MIN: От 5 минут до недели. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_15_MIN: От 15 минут до 3 недель. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_HOUR: От 1 часа до 3 месяцев. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_DAY: От 1 дня до 6 лет. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_2_MIN: От 2 минут до 1 дня. Максимальное значение `limit` — 1200.\n - CANDLE_INTERVAL_3_MIN: От 3 минут до 1 дня. Максимальное значение `limit` — 750.\n - CANDLE_INTERVAL_10_MIN: От 10 минут до недели. Максимальное значение `limit` — 1200.\n - CANDLE_INTERVAL_30_MIN: От 30 минут до 3 недель. Максимальное значение `limit` — 1200.\n - CANDLE_INTERVAL_2_HOUR: От 2 часов до 3 месяцев. Максимальное значение `limit` — 2400.\n - CANDLE_INTERVAL_4_HOUR: От 4 часов до 3 месяцев. Максимальное значение `limit` — 700.\n - CANDLE_INTERVAL_WEEK: От 1 недели до 5 лет. Максимальное значение `limit` — 300.\n - CANDLE_INTERVAL_MONTH: От 1 месяца до 10 лет. Максимальное значение `limit` — 120."
enum:
- "CANDLE_INTERVAL_UNSPECIFIED"
- "CANDLE_INTERVAL_1_MIN"
- "CANDLE_INTERVAL_5_MIN"
- "CANDLE_INTERVAL_15_MIN"
- "CANDLE_INTERVAL_HOUR"
- "CANDLE_INTERVAL_DAY"
- "CANDLE_INTERVAL_2_MIN"
- "CANDLE_INTERVAL_3_MIN"
- "CANDLE_INTERVAL_10_MIN"
- "CANDLE_INTERVAL_30_MIN"
- "CANDLE_INTERVAL_2_HOUR"
- "CANDLE_INTERVAL_4_HOUR"
- "CANDLE_INTERVAL_WEEK"
- "CANDLE_INTERVAL_MONTH"
type: "string"
v1CandleSubscription:
description: "Статус подписки на свечи."
example:
streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
interval:
$ref: "#/components/schemas/v1SubscriptionInterval"
subscriptionStatus:
$ref: "#/components/schemas/v1SubscriptionStatus"
instrumentUid:
description: "UID инструмента."
type: "string"
waitingClose:
description: "Флаг ожидания закрытия временного интервала для отправки свечи."
type: "boolean"
streamId:
description: "Идентификатор открытого соединения."
type: "string"
subscriptionId:
description: "Идентификатор подписки в формате `UUID`."
type: "string"
candleSourceType:
$ref: "#/components/schemas/v1GetCandlesRequestCandleSource"
type: "object"
v1ChildOperationItem:
example:
instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
properties:
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
payment:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1CloseSandboxAccountRequest:
description: "Запрос закрытия счета в песочнице."
properties:
accountId:
title: "Номер счета"
type: "string"
required:
- "accountId"
type: "object"
v1CloseSandboxAccountResponse:
description: "Результат закрытия счета в песочнице.\n\nпустой ответ"
type: "object"
v1CountryResponse:
description: "Данные о стране."
example:
alfaTwo: "alfaTwo"
alfaThree: "alfaThree"
name: "name"
nameBrief: "nameBrief"
properties:
alfaTwo:
description: "Двухбуквенный код страны."
type: "string"
alfaThree:
description: "Трехбуквенный код страны."
type: "string"
name:
description: "Наименование страны."
type: "string"
nameBrief:
description: "Краткое наименование страны."
type: "string"
type: "object"
v1Coupon:
description: "Объект передачи информации о купоне облигации."
example:
fixDate: 2000-01-23T04:56:07.000Z
couponPeriod: 0
couponNumber: "couponNumber"
couponEndDate: 2000-01-23T04:56:07.000Z
figi: "figi"
couponDate: 2000-01-23T04:56:07.000Z
couponStartDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
couponDate:
description: "Дата выплаты купона."
format: "date-time"
type: "string"
couponNumber:
description: "Номер купона."
format: "int64"
type: "string"
fixDate:
description: "Дата фиксации реестра для выплаты купона — опционально."
format: "date-time"
type: "string"
payOneBond:
$ref: "#/components/schemas/v1MoneyValue"
couponType:
$ref: "#/components/schemas/v1CouponType"
couponStartDate:
description: "Начало купонного периода."
format: "date-time"
type: "string"
couponEndDate:
description: "Окончание купонного периода."
format: "date-time"
type: "string"
couponPeriod:
description: "Купонный период в днях."
format: "int32"
type: "integer"
type: "object"
v1CouponType:
default: "COUPON_TYPE_UNSPECIFIED"
description: "Тип купонов.\n\n - COUPON_TYPE_UNSPECIFIED: Неопределенное значение.\n - COUPON_TYPE_CONSTANT: Постоянный.\n - COUPON_TYPE_FLOATING: Плавающий.\n - COUPON_TYPE_DISCOUNT: Дисконт.\n - COUPON_TYPE_MORTGAGE: Ипотечный.\n - COUPON_TYPE_FIX: Фиксированный.\n - COUPON_TYPE_VARIABLE: Переменный.\n - COUPON_TYPE_OTHER: Прочее."
enum:
- "COUPON_TYPE_UNSPECIFIED"
- "COUPON_TYPE_CONSTANT"
- "COUPON_TYPE_FLOATING"
- "COUPON_TYPE_DISCOUNT"
- "COUPON_TYPE_MORTGAGE"
- "COUPON_TYPE_FIX"
- "COUPON_TYPE_VARIABLE"
- "COUPON_TYPE_OTHER"
type: "string"
v1CreateFavoriteGroupRequest:
description: "Запрос создания новой группы избранных инструментов."
properties:
groupName:
description: "Название группы, не более 255 символов."
type: "string"
groupColor:
title: "Цвет группы. Принимает значения в HEX-формате, от \"000000\" до \"FFFFFF\""
type: "string"
note:
title: "Описание"
type: "string"
required:
- "groupColor"
- "groupName"
type: "object"
v1CreateFavoriteGroupResponse:
example:
groupName: "groupName"
groupId: "groupId"
properties:
groupId:
description: "Уникальный идентификатор группы."
type: "string"
groupName:
description: "Название группы."
type: "string"
type: "object"
v1CurrenciesResponse:
description: "Данные по валютам."
example:
instruments:
- isoCurrencyName: "isoCurrencyName"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
- isoCurrencyName: "isoCurrencyName"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instruments:
description: "Массив валют."
items:
$ref: "#/components/schemas/v1Currency"
type: "array"
type: "object"
v1Currency:
description: "Объект передачи информации о валюте."
example:
isoCurrencyName: "isoCurrencyName"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
lot:
description: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)."
format: "int32"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций в шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
nominal:
$ref: "#/components/schemas/v1MoneyValue"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
isoCurrencyName:
description: "Строковый ISO-код валюты."
type: "string"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Параметр указывает на возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
brand:
$ref: "#/components/schemas/v1BrandData"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1CurrencyResponse:
description: "Данные по валюте."
example:
instrument:
isoCurrencyName: "isoCurrencyName"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instrument:
$ref: "#/components/schemas/v1Currency"
type: "object"
v1DeleteFavoriteGroupRequest:
properties:
groupId:
description: "Уникальный идентификатор группы."
type: "string"
required:
- "groupId"
type: "object"
v1DeleteFavoriteGroupResponse:
type: "object"
v1Dividend:
description: "Информация о выплате."
example:
declaredDate: 2000-01-23T04:56:07.000Z
createdAt: 2000-01-23T04:56:07.000Z
recordDate: 2000-01-23T04:56:07.000Z
yieldValue:
nano: 6
units: "units"
closePrice:
nano: 5
currency: "currency"
units: "units"
paymentDate: 2000-01-23T04:56:07.000Z
regularity: "regularity"
dividendNet:
nano: 5
currency: "currency"
units: "units"
lastBuyDate: 2000-01-23T04:56:07.000Z
dividendType: "dividendType"
properties:
dividendNet:
$ref: "#/components/schemas/v1MoneyValue"
paymentDate:
description: "Дата фактических выплат по UTC."
format: "date-time"
type: "string"
declaredDate:
description: "Дата объявления дивидендов по UTC."
format: "date-time"
type: "string"
lastBuyDate:
description: "Последний день (включительно) покупки для получения выплаты по UTC."
format: "date-time"
type: "string"
dividendType:
description: "Тип выплаты. Возможные значения: `Regular Cash` – регулярные выплаты, `Cancelled` – выплата отменена, `Daily Accrual` – ежедневное начисление, `Return of Capital` – возврат капитала, прочие типы выплат."
type: "string"
recordDate:
description: "Дата фиксации реестра по UTC."
format: "date-time"
type: "string"
regularity:
description: "Регулярность выплаты. Возможные значения: `Annual` – ежегодная, `Semi-Anl` – каждые полгода, прочие типы выплат."
type: "string"
closePrice:
$ref: "#/components/schemas/v1MoneyValue"
yieldValue:
$ref: "#/components/schemas/v1Quotation"
createdAt:
description: "Дата и время создания записи по UTC."
format: "date-time"
type: "string"
type: "object"
v1DividendsForeignIssuerReport:
description: "Отчет «Справка о доходах за пределами РФ»."
example:
issuerCountry: "issuerCountry"
externalCommission:
nano: 6
units: "units"
securityName: "securityName"
dividendGross:
nano: 6
units: "units"
quantity: "quantity"
dividendAmount:
nano: 6
units: "units"
recordDate: 2000-01-23T04:56:07.000Z
dividend:
nano: 6
units: "units"
tax:
nano: 6
units: "units"
currency: "currency"
paymentDate: 2000-01-23T04:56:07.000Z
isin: "isin"
properties:
recordDate:
description: "Дата фиксации реестра."
format: "date-time"
type: "string"
paymentDate:
description: "Дата выплаты."
format: "date-time"
type: "string"
securityName:
description: "Наименование ценной бумаги."
type: "string"
isin:
description: "ISIN-идентификатор ценной бумаги."
type: "string"
issuerCountry:
description: "Страна эмитента. Для депозитарных расписок указывается страна эмитента базового актива."
type: "string"
quantity:
description: "Количество ценных бумаг."
format: "int64"
type: "string"
dividend:
$ref: "#/components/schemas/v1Quotation"
externalCommission:
$ref: "#/components/schemas/v1Quotation"
dividendGross:
$ref: "#/components/schemas/v1Quotation"
tax:
$ref: "#/components/schemas/v1Quotation"
dividendAmount:
$ref: "#/components/schemas/v1Quotation"
currency:
description: "Валюта."
type: "string"
type: "object"
v1EditFavoritesActionType:
default: "EDIT_FAVORITES_ACTION_TYPE_UNSPECIFIED"
description: "Тип действия со списком избранных инструментов.\n\n - EDIT_FAVORITES_ACTION_TYPE_UNSPECIFIED: Тип не определен.\n - EDIT_FAVORITES_ACTION_TYPE_ADD: Добавить в список.\n - EDIT_FAVORITES_ACTION_TYPE_DEL: Удалить из списка."
enum:
- "EDIT_FAVORITES_ACTION_TYPE_UNSPECIFIED"
- "EDIT_FAVORITES_ACTION_TYPE_ADD"
- "EDIT_FAVORITES_ACTION_TYPE_DEL"
type: "string"
v1EditFavoritesRequest:
description: "Запрос редактирования списка избранных инструментов."
properties:
instruments:
description: "Массив инструментов."
items:
$ref: "#/components/schemas/v1EditFavoritesRequestInstrument"
type: "array"
actionType:
$ref: "#/components/schemas/v1EditFavoritesActionType"
groupId:
description: "Уникальный идентификатор группы."
type: "string"
required:
- "actionType"
- "instruments"
type: "object"
v1EditFavoritesRequestInstrument:
description: "Массив инструментов для редактирования списка избранных инструментов."
properties:
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
required:
- "instrumentId"
type: "object"
v1EditFavoritesResponse:
description: "Результат редактирования списка избранных инструментов."
example:
favoriteInstruments:
- otcFlag: true
classCode: "classCode"
uid: "uid"
ticker: "ticker"
instrumentType: "instrumentType"
name: "name"
figi: "figi"
apiTradeAvailableFlag: true
isin: "isin"
- otcFlag: true
classCode: "classCode"
uid: "uid"
ticker: "ticker"
instrumentType: "instrumentType"
name: "name"
figi: "figi"
apiTradeAvailableFlag: true
isin: "isin"
groupId: "groupId"
properties:
favoriteInstruments:
description: "Массив инструментов."
items:
$ref: "#/components/schemas/v1FavoriteInstrument"
type: "array"
groupId:
description: "Уникальный идентификатор группы."
type: "string"
type: "object"
v1ErrorDetail:
example:
code: "code"
message: "message"
properties:
code:
description: "Код ошибки."
type: "string"
message:
description: "Описание ошибки."
type: "string"
type: "object"
v1Etf:
description: "Объект передачи информации об инвестиционном фонде."
example:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
focusType: "focusType"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
rebalancingFreq: "rebalancingFreq"
name: "name"
numShares:
nano: 6
units: "units"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
lot:
description: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)."
format: "int32"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций в шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
fixedCommission:
$ref: "#/components/schemas/v1Quotation"
focusType:
description: "Возможные значения: <br/>**equity** — акции;<br/>**fixed_income** — облигации;<br/>**mixed_allocation** — смешанный;<br/>**money_market** — денежный рынок;<br/>**real_estate** — недвижимость;<br/>**commodity** — товары;<br/>**specialty** — специальный;<br/>**private_equity** — private equity;<br/>**alternative_investment** — альтернативные инвестиции."
type: "string"
releasedDate:
description: "Дата выпуска по UTC."
format: "date-time"
type: "string"
numShares:
$ref: "#/components/schemas/v1Quotation"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
sector:
description: "Сектор экономики."
type: "string"
rebalancingFreq:
description: "Частота ребалансировки."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Параметр указывает на возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
assetUid:
description: "Уникальный идентификатор актива."
type: "string"
instrumentExchange:
$ref: "#/components/schemas/v1InstrumentExchangeType"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "ФлагФлаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
liquidityFlag:
description: "Флаг достаточной ликвидности."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
brand:
$ref: "#/components/schemas/v1BrandData"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1EtfResponse:
description: "Данные по фонду."
example:
instrument:
releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
focusType: "focusType"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
rebalancingFreq: "rebalancingFreq"
name: "name"
numShares:
nano: 6
units: "units"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instrument:
$ref: "#/components/schemas/v1Etf"
type: "object"
v1EtfsResponse:
description: "Данные по фондам."
example:
instruments:
- releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
focusType: "focusType"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
rebalancingFreq: "rebalancingFreq"
name: "name"
numShares:
nano: 6
units: "units"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
- releasedDate: 2000-01-23T04:56:07.000Z
fixedCommission:
nano: 6
units: "units"
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
focusType: "focusType"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
rebalancingFreq: "rebalancingFreq"
name: "name"
numShares:
nano: 6
units: "units"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instruments:
description: "Массив фондов."
items:
$ref: "#/components/schemas/v1Etf"
type: "array"
type: "object"
v1ExchangeOrderType:
default: "EXCHANGE_ORDER_TYPE_UNSPECIFIED"
description: "Тип выставляемой заявки.\n\n - EXCHANGE_ORDER_TYPE_UNSPECIFIED: Значение не указано.\n - EXCHANGE_ORDER_TYPE_MARKET: Заявка по рыночной цене.\n - EXCHANGE_ORDER_TYPE_LIMIT: Лимитная заявка."
enum:
- "EXCHANGE_ORDER_TYPE_UNSPECIFIED"
- "EXCHANGE_ORDER_TYPE_MARKET"
- "EXCHANGE_ORDER_TYPE_LIMIT"
type: "string"
v1FavoriteInstrument:
description: "Массив избранных инструментов."
example:
otcFlag: true
classCode: "classCode"
uid: "uid"
ticker: "ticker"
instrumentType: "instrumentType"
name: "name"
figi: "figi"
apiTradeAvailableFlag: true
isin: "isin"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код инструмента."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
name:
description: "Название инструмента."
type: "string"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
apiTradeAvailableFlag:
description: "Возможность торговать инструментом через API."
type: "boolean"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
type: "object"
v1FilterOptionsRequest:
description: "Параметры фильтрации опционов."
properties:
basicAssetUid:
description: "Идентификатор базового актива опциона. Обязательный параметр."
type: "string"
basicAssetPositionUid:
description: "Идентификатор позиции базового актива опциона."
type: "string"
type: "object"
v1FindInstrumentRequest:
description: "Запрос на поиск инструментов."
properties:
query:
description: "Строка поиска."
type: "string"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
apiTradeAvailableFlag:
description: "Фильтр для отображения только торговых инструментов."
type: "boolean"
required:
- "query"
type: "object"
v1FindInstrumentResponse:
description: "Результат поиска инструментов."
example:
instruments:
- weekendFlag: true
classCode: "classCode"
ticker: "ticker"
instrumentType: "instrumentType"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
figi: "figi"
apiTradeAvailableFlag: true
first1minCandleDate: 2000-01-23T04:56:07.000Z
lot: 0
uid: "uid"
blockedTcaFlag: true
name: "name"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
isin: "isin"
- weekendFlag: true
classCode: "classCode"
ticker: "ticker"
instrumentType: "instrumentType"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
figi: "figi"
apiTradeAvailableFlag: true
first1minCandleDate: 2000-01-23T04:56:07.000Z
lot: 0
uid: "uid"
blockedTcaFlag: true
name: "name"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
isin: "isin"
properties:
instruments:
description: "Массив инструментов, удовлетворяющих условиям поиска."
items:
$ref: "#/components/schemas/v1InstrumentShort"
type: "array"
type: "object"
v1Future:
description: "Объект передачи информации о фьючерсе."
example:
initialMarginOnSell:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
futuresType: "futuresType"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
minPriceIncrementAmount:
nano: 6
units: "units"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
initialMarginOnBuy:
nano: 5
currency: "currency"
units: "units"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
lot:
description: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)."
format: "int32"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
firstTradeDate:
description: "Дата начала обращения контракта по UTC."
format: "date-time"
type: "string"
lastTradeDate:
description: "Дата по UTC, до которой возможно проведение операций с фьючерсом."
format: "date-time"
type: "string"
futuresType:
description: "Тип фьючерса. Возможные значения: <br/>**physical_delivery** — физические поставки; <br/>**cash_settlement** — денежный эквивалент."
type: "string"
assetType:
description: "Тип актива. Возможные значения: <br/>**commodity** — товар; <br/>**currency** — валюта; <br/>**security** — ценная бумага; <br/>**index** — индекс."
type: "string"
basicAsset:
description: "Основной актив."
type: "string"
basicAssetSize:
$ref: "#/components/schemas/v1Quotation"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
sector:
description: "Сектор экономики."
type: "string"
expirationDate:
description: "Дата истечения срока в часов поясе UTC."
format: "date-time"
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Параметр указывает на возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
basicAssetPositionUid:
description: "Уникальный идентификатор позиции основного инструмента."
type: "string"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
initialMarginOnBuy:
$ref: "#/components/schemas/v1MoneyValue"
initialMarginOnSell:
$ref: "#/components/schemas/v1MoneyValue"
minPriceIncrementAmount:
$ref: "#/components/schemas/v1Quotation"
brand:
$ref: "#/components/schemas/v1BrandData"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1FutureResponse:
description: "Данные по фьючерсу."
example:
instrument:
initialMarginOnSell:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
futuresType: "futuresType"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
minPriceIncrementAmount:
nano: 6
units: "units"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
initialMarginOnBuy:
nano: 5
currency: "currency"
units: "units"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
properties:
instrument:
$ref: "#/components/schemas/v1Future"
type: "object"
v1FuturesResponse:
description: "Данные по фьючерсам."
example:
instruments:
- initialMarginOnSell:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
futuresType: "futuresType"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
minPriceIncrementAmount:
nano: 6
units: "units"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
initialMarginOnBuy:
nano: 5
currency: "currency"
units: "units"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
- initialMarginOnSell:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
futuresType: "futuresType"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
minPriceIncrementAmount:
nano: 6
units: "units"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
initialMarginOnBuy:
nano: 5
currency: "currency"
units: "units"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
properties:
instruments:
description: "Массив фьючерсов."
items:
$ref: "#/components/schemas/v1Future"
type: "array"
type: "object"
v1GenerateBrokerReportRequest:
properties:
accountId:
description: "Идентификатор счета клиента."
type: "string"
from:
description: "Начало периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание периода по UTC."
format: "date-time"
type: "string"
required:
- "accountId"
- "from"
- "to"
type: "object"
v1GenerateBrokerReportResponse:
example:
taskId: "taskId"
properties:
taskId:
description: "Идентификатор задачи формирования брокерского отчета."
type: "string"
type: "object"
v1GenerateDividendsForeignIssuerReportRequest:
description: "Объект запроса формирования отчета «Справка о доходах за пределами РФ»."
properties:
accountId:
description: "Идентификатор счета клиента."
type: "string"
from:
description: "Начало периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание периода по UTC. Как правило, можно сформировать отчет по дату на несколько дней меньше текущей. Начало и окончание периода должны быть в рамках одного календарного года."
format: "date-time"
type: "string"
required:
- "accountId"
- "from"
- "to"
type: "object"
v1GenerateDividendsForeignIssuerReportResponse:
description: "Объект результата задачи запуска формирования отчета «Справка о доходах за пределами РФ»."
example:
taskId: "taskId"
properties:
taskId:
description: "Идентификатор задачи формирования отчета."
type: "string"
type: "object"
v1GetAccountsRequest:
description: "Запрос получения счетов пользователя."
properties:
status:
$ref: "#/components/schemas/v1AccountStatus"
type: "object"
v1GetAccountsResponse:
description: "Список счетов пользователя."
example:
accounts:
- openedDate: 2000-01-23T04:56:07.000Z
closedDate: 2000-01-23T04:56:07.000Z
name: "name"
id: "id"
- openedDate: 2000-01-23T04:56:07.000Z
closedDate: 2000-01-23T04:56:07.000Z
name: "name"
id: "id"
properties:
accounts:
description: "Массив счетов клиента."
items:
$ref: "#/components/schemas/v1Account"
type: "array"
type: "object"
v1GetAccruedInterestsRequest:
description: "Запрос НКД по облигации."
properties:
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
required:
- "from"
- "instrumentId"
- "to"
type: "object"
v1GetAccruedInterestsResponse:
description: "НКД облигации."
example:
accruedInterests:
- date: 2000-01-23T04:56:07.000Z
valuePercent:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
value:
nano: 6
units: "units"
- date: 2000-01-23T04:56:07.000Z
valuePercent:
nano: 6
units: "units"
nominal:
nano: 6
units: "units"
value:
nano: 6
units: "units"
properties:
accruedInterests:
description: "Массив операций начисления купонов."
items:
$ref: "#/components/schemas/v1AccruedInterest"
type: "array"
type: "object"
v1GetAssetFundamentalsRequest:
properties:
assets:
description: "Массив идентификаторов активов, не более 100 шт."
items:
type: "string"
type: "array"
required:
- "assets"
title: "Запрос фундаментальных показателей"
type: "object"
v1GetAssetFundamentalsResponse:
example:
fundamentals:
- domicileIndicatorCode: "domicileIndicatorCode"
assetUid: "assetUid"
dividendYieldDailyTtm: 3.0937452626664474
priceToSalesTtm: 4.965218492984954
adrToCommonShareRatio: 7.740351818741173
highPriceLast52Weeks: 6.027456183070403
dividendRateTtm: 7.143538047012306
revenueChangeFiveYears: 3.0576100241049344
totalDebtMrq: 1.284659006116532
fiveYearAnnualRevenueGrowthRate: 6.84685269835264
fiveYearAnnualDividendGrowthRate: 6.519180951018382
freeFloat: 7.061401241503109
freeCashFlowToPrice: 6.878052220127876
revenueTtm: 2.027123023002322
totalEnterpriseValueMrq: 9.369310271410669
epsTtm: 1.2315135367772556
peRatioTtm: 1.1730742509559433
fiscalPeriodStartDate: 2000-01-23T04:56:07.000Z
evToSales: 4.078845849666752
fiscalPeriodEndDate: 2000-01-23T04:56:07.000Z
roic: 6.965117697638846
dividendPayoutRatioFy: 0.10263654006109402
marketCapitalization: 0.8008281904610115
ebitdaChangeFiveYears: 5.533258397034986
epsChangeFiveYears: 7.04836565559697
priceToFreeCashFlowTtm: 9.965781217890562
numberOfEmployees: 3.0205796992916243
netInterestMarginMrq: 9.018348186070783
oneYearAnnualRevenueGrowthRate: 8.969578798196912
currentRatioMrq: 6.704019297950036
averageDailyVolumeLast4Weeks: 5.637376656633329
forwardAnnualDividendYield: 9.301444243932576
netMarginMrq: 8.762042012749001
roa: 3.5571952270680973
totalDebtToEbitdaMrq: 6.778324963048013
roe: 6.438423552598547
freeCashFlowTtm: 1.4894159098541704
evToEbitdaMrq: 6.683562403749608
fiveYearsAverageDividendYield: 7.058770351582356
priceToBookTtm: 5.025004791520295
totalDebtToEquityMrq: 2.8841621266687802
averageDailyVolumeLast10Days: 5.962133916683182
fixedChargeCoverageRatioFy: 3.353193347011243
currency: "currency"
netIncomeTtm: 7.386281948385884
sharesOutstanding: 3.616076749251911
beta: 2.3021358869347655
threeYearAnnualRevenueGrowthRate: 7.457744773683766
totalDebtChangeFiveYears: 3.2588565619047607
lowPriceLast52Weeks: 1.4658129805029452
exDividendDate: 2000-01-23T04:56:07.000Z
ebitdaTtm: 4.145608029883936
netDebtToEbitda: 5.944895607614016
dilutedEpsTtm: 1.0246457001441578
buyBackTtm: 4.652396432933246
dividendsPerShare: 0.8851374739011653
- domicileIndicatorCode: "domicileIndicatorCode"
assetUid: "assetUid"
dividendYieldDailyTtm: 3.0937452626664474
priceToSalesTtm: 4.965218492984954
adrToCommonShareRatio: 7.740351818741173
highPriceLast52Weeks: 6.027456183070403
dividendRateTtm: 7.143538047012306
revenueChangeFiveYears: 3.0576100241049344
totalDebtMrq: 1.284659006116532
fiveYearAnnualRevenueGrowthRate: 6.84685269835264
fiveYearAnnualDividendGrowthRate: 6.519180951018382
freeFloat: 7.061401241503109
freeCashFlowToPrice: 6.878052220127876
revenueTtm: 2.027123023002322
totalEnterpriseValueMrq: 9.369310271410669
epsTtm: 1.2315135367772556
peRatioTtm: 1.1730742509559433
fiscalPeriodStartDate: 2000-01-23T04:56:07.000Z
evToSales: 4.078845849666752
fiscalPeriodEndDate: 2000-01-23T04:56:07.000Z
roic: 6.965117697638846
dividendPayoutRatioFy: 0.10263654006109402
marketCapitalization: 0.8008281904610115
ebitdaChangeFiveYears: 5.533258397034986
epsChangeFiveYears: 7.04836565559697
priceToFreeCashFlowTtm: 9.965781217890562
numberOfEmployees: 3.0205796992916243
netInterestMarginMrq: 9.018348186070783
oneYearAnnualRevenueGrowthRate: 8.969578798196912
currentRatioMrq: 6.704019297950036
averageDailyVolumeLast4Weeks: 5.637376656633329
forwardAnnualDividendYield: 9.301444243932576
netMarginMrq: 8.762042012749001
roa: 3.5571952270680973
totalDebtToEbitdaMrq: 6.778324963048013
roe: 6.438423552598547
freeCashFlowTtm: 1.4894159098541704
evToEbitdaMrq: 6.683562403749608
fiveYearsAverageDividendYield: 7.058770351582356
priceToBookTtm: 5.025004791520295
totalDebtToEquityMrq: 2.8841621266687802
averageDailyVolumeLast10Days: 5.962133916683182
fixedChargeCoverageRatioFy: 3.353193347011243
currency: "currency"
netIncomeTtm: 7.386281948385884
sharesOutstanding: 3.616076749251911
beta: 2.3021358869347655
threeYearAnnualRevenueGrowthRate: 7.457744773683766
totalDebtChangeFiveYears: 3.2588565619047607
lowPriceLast52Weeks: 1.4658129805029452
exDividendDate: 2000-01-23T04:56:07.000Z
ebitdaTtm: 4.145608029883936
netDebtToEbitda: 5.944895607614016
dilutedEpsTtm: 1.0246457001441578
buyBackTtm: 4.652396432933246
dividendsPerShare: 0.8851374739011653
properties:
fundamentals:
items:
$ref: "#/components/schemas/GetAssetFundamentalsResponseStatisticResponse"
type: "array"
title: "Фундаментальные показатели"
type: "object"
v1GetAssetReportsRequest:
properties:
instrumentId:
description: "Идентификатор инструмента в формате UID."
type: "string"
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
required:
- "instrumentId"
title: "Запрос отчетов эмитентов"
type: "object"
v1GetAssetReportsResponse:
example:
events:
- periodNum: 6
createdAt: 2000-01-23T04:56:07.000Z
reportDate: 2000-01-23T04:56:07.000Z
periodYear: 0
instrumentId: "instrumentId"
- periodNum: 6
createdAt: 2000-01-23T04:56:07.000Z
reportDate: 2000-01-23T04:56:07.000Z
periodYear: 0
instrumentId: "instrumentId"
properties:
events:
description: "Массив событий по облигации."
items:
$ref: "#/components/schemas/GetAssetReportsResponseGetAssetReportsEvent"
type: "array"
title: "Отчеты эмитентов"
type: "object"
v1GetBondCouponsRequest:
description: "Запрос купонов по облигации."
properties:
from:
description: "Начало запрашиваемого периода по UTC. Фильтрация по `coupon_date` — дата выплаты купона."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC. Фильтрация по `coupon_date` — дата выплаты купона."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
required:
- "instrumentId"
type: "object"
v1GetBondCouponsResponse:
description: "Купоны по облигации."
example:
events:
- fixDate: 2000-01-23T04:56:07.000Z
couponPeriod: 0
couponNumber: "couponNumber"
couponEndDate: 2000-01-23T04:56:07.000Z
figi: "figi"
couponDate: 2000-01-23T04:56:07.000Z
couponStartDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
- fixDate: 2000-01-23T04:56:07.000Z
couponPeriod: 0
couponNumber: "couponNumber"
couponEndDate: 2000-01-23T04:56:07.000Z
figi: "figi"
couponDate: 2000-01-23T04:56:07.000Z
couponStartDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
properties:
events:
items:
$ref: "#/components/schemas/v1Coupon"
type: "array"
type: "object"
v1GetBondEventsRequest:
description: "События по облигации."
properties:
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
type:
$ref: "#/components/schemas/GetBondEventsRequestEventType"
required:
- "instrumentId"
type: "object"
v1GetBondEventsResponse:
description: "Объект передачи информации о событии облигации."
example:
events:
- fixDate: 2000-01-23T04:56:07.000Z
execution: "execution"
note: "note"
defaultDate: 2000-01-23T04:56:07.000Z
eventNumber: 0
instrumentId: "instrumentId"
couponEndDate: 2000-01-23T04:56:07.000Z
rateDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
moneyFlowVal:
nano: 5
currency: "currency"
units: "units"
couponPeriod: 6
convertToFinToolId: "convertToFinToolId"
couponInterestRate:
nano: 6
units: "units"
eventTotalVol:
nano: 6
units: "units"
realPayDate: 2000-01-23T04:56:07.000Z
operationType: "operationType"
value:
nano: 6
units: "units"
couponStartDate: 2000-01-23T04:56:07.000Z
eventDate: 2000-01-23T04:56:07.000Z
payDate: 2000-01-23T04:56:07.000Z
- fixDate: 2000-01-23T04:56:07.000Z
execution: "execution"
note: "note"
defaultDate: 2000-01-23T04:56:07.000Z
eventNumber: 0
instrumentId: "instrumentId"
couponEndDate: 2000-01-23T04:56:07.000Z
rateDate: 2000-01-23T04:56:07.000Z
payOneBond:
nano: 5
currency: "currency"
units: "units"
moneyFlowVal:
nano: 5
currency: "currency"
units: "units"
couponPeriod: 6
convertToFinToolId: "convertToFinToolId"
couponInterestRate:
nano: 6
units: "units"
eventTotalVol:
nano: 6
units: "units"
realPayDate: 2000-01-23T04:56:07.000Z
operationType: "operationType"
value:
nano: 6
units: "units"
couponStartDate: 2000-01-23T04:56:07.000Z
eventDate: 2000-01-23T04:56:07.000Z
payDate: 2000-01-23T04:56:07.000Z
properties:
events:
items:
$ref: "#/components/schemas/GetBondEventsResponseBondEvent"
type: "array"
type: "object"
v1GetBrandRequest:
description: "Запрос бренда."
properties:
id:
description: "UID-идентификатор бренда."
type: "string"
required:
- "id"
type: "object"
v1GetBrandsRequest:
description: "Запрос списка брендов."
properties:
paging:
$ref: "#/components/schemas/v1Page"
type: "object"
v1GetBrandsResponse:
description: "Список брендов."
example:
brands:
- uid: "uid"
name: "name"
description: "description"
company: "company"
sector: "sector"
countryOfRiskName: "countryOfRiskName"
info: "info"
countryOfRisk: "countryOfRisk"
- uid: "uid"
name: "name"
description: "description"
company: "company"
sector: "sector"
countryOfRiskName: "countryOfRiskName"
info: "info"
countryOfRisk: "countryOfRisk"
paging:
pageNumber: 6
limit: 0
totalCount: 1
properties:
brands:
description: "Массив брендов."
items:
$ref: "#/components/schemas/v1Brand"
type: "array"
paging:
$ref: "#/components/schemas/v1PageResponse"
type: "object"
v1GetBrokerReportRequest:
properties:
taskId:
description: "Идентификатор задачи формирования брокерского отчета."
type: "string"
page:
description: "Номер страницы отчета, начинается с 1. Значение по умолчанию — 0."
format: "int32"
type: "integer"
required:
- "taskId"
type: "object"
v1GetBrokerReportResponse:
example:
brokerReport:
- exchangeClearingCommission:
nano: 5
currency: "currency"
units: "units"
separateAgreementDate: "separateAgreementDate"
orderId: "orderId"
figi: "figi"
executeSign: "executeSign"
brokerCommission:
nano: 5
currency: "currency"
units: "units"
repoRate:
nano: 6
units: "units"
orderAmount:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 6
units: "units"
secValueDate: 2000-01-23T04:56:07.000Z
direction: "direction"
classCode: "classCode"
ticker: "ticker"
quantity: "quantity"
deliveryType: "deliveryType"
tradeDatetime: 2000-01-23T04:56:07.000Z
exchangeCommission:
nano: 5
currency: "currency"
units: "units"
brokerStatus: "brokerStatus"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
separateAgreementNumber: "separateAgreementNumber"
clearValueDate: 2000-01-23T04:56:07.000Z
name: "name"
exchange: "exchange"
separateAgreementType: "separateAgreementType"
tradeId: "tradeId"
party: "party"
- exchangeClearingCommission:
nano: 5
currency: "currency"
units: "units"
separateAgreementDate: "separateAgreementDate"
orderId: "orderId"
figi: "figi"
executeSign: "executeSign"
brokerCommission:
nano: 5
currency: "currency"
units: "units"
repoRate:
nano: 6
units: "units"
orderAmount:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 6
units: "units"
secValueDate: 2000-01-23T04:56:07.000Z
direction: "direction"
classCode: "classCode"
ticker: "ticker"
quantity: "quantity"
deliveryType: "deliveryType"
tradeDatetime: 2000-01-23T04:56:07.000Z
exchangeCommission:
nano: 5
currency: "currency"
units: "units"
brokerStatus: "brokerStatus"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
separateAgreementNumber: "separateAgreementNumber"
clearValueDate: 2000-01-23T04:56:07.000Z
name: "name"
exchange: "exchange"
separateAgreementType: "separateAgreementType"
tradeId: "tradeId"
party: "party"
pagesCount: 6
page: 1
itemsCount: 0
properties:
brokerReport:
items:
$ref: "#/components/schemas/v1BrokerReport"
type: "array"
itemsCount:
description: "Количество записей в отчете."
format: "int32"
type: "integer"
pagesCount:
description: "Количество страниц с данными отчета, начинается с 0."
format: "int32"
type: "integer"
page:
description: "Текущая страница, начинается с 0."
format: "int32"
type: "integer"
type: "object"
v1GetCandlesRequest:
description: "Запрос исторических свечей."
properties:
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
interval:
$ref: "#/components/schemas/v1CandleInterval"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
candleSourceType:
$ref: "#/components/schemas/v1GetCandlesRequestCandleSource"
limit:
description: "Максимальное количество свечей в ответе."
format: "int32"
type: "integer"
required:
- "from"
- "interval"
- "to"
type: "object"
v1GetCandlesRequestCandleSource:
default: "CANDLE_SOURCE_UNSPECIFIED"
description: " - CANDLE_SOURCE_UNSPECIFIED: Все свечи.\n - CANDLE_SOURCE_EXCHANGE: Биржевые свечи.\n - CANDLE_SOURCE_INCLUDE_WEEKEND: Все свечи с учетом торговли по выходным."
enum:
- "CANDLE_SOURCE_UNSPECIFIED"
- "CANDLE_SOURCE_EXCHANGE"
- "CANDLE_SOURCE_INCLUDE_WEEKEND"
type: "string"
v1GetCandlesResponse:
description: "Список свечей."
example:
candles:
- volume: "volume"
high:
nano: 6
units: "units"
low:
nano: 6
units: "units"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
isComplete: true
- volume: "volume"
high:
nano: 6
units: "units"
low:
nano: 6
units: "units"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
isComplete: true
properties:
candles:
description: "Массив свечей."
items:
$ref: "#/components/schemas/v1HistoricCandle"
type: "array"
type: "object"
v1GetClosePricesRequest:
description: "Запрос цен закрытия торговой сессии по инструментам."
properties:
instruments:
description: "Массив по инструментам."
items:
$ref: "#/components/schemas/v1InstrumentClosePriceRequest"
type: "array"
instrumentStatus:
$ref: "#/components/schemas/v1InstrumentStatus"
required:
- "instruments"
type: "object"
v1GetClosePricesResponse:
description: "Цены закрытия торговой сессии по инструментам."
example:
closePrices:
- eveningSessionPrice:
nano: 6
units: "units"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
- eveningSessionPrice:
nano: 6
units: "units"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
closePrices:
description: "Массив по инструментам."
items:
$ref: "#/components/schemas/v1InstrumentClosePriceResponse"
type: "array"
type: "object"
v1GetConsensusForecastsRequest:
properties:
paging:
$ref: "#/components/schemas/v1Page"
title: "Запрос консенсус-прогнозов"
type: "object"
v1GetConsensusForecastsResponse:
example:
page:
pageNumber: 6
limit: 0
totalCount: 1
items:
- uid: "uid"
assetUid: "assetUid"
createdAt: 2000-01-23T04:56:07.000Z
bestTargetHigh:
nano: 6
units: "units"
bestTargetLow:
nano: 6
units: "units"
totalSellRecommend: 1
currency: "currency"
bestTargetPrice:
nano: 6
units: "units"
totalHoldRecommend: 6
prognosisDate: 2000-01-23T04:56:07.000Z
totalBuyRecommend: 0
- uid: "uid"
assetUid: "assetUid"
createdAt: 2000-01-23T04:56:07.000Z
bestTargetHigh:
nano: 6
units: "units"
bestTargetLow:
nano: 6
units: "units"
totalSellRecommend: 1
currency: "currency"
bestTargetPrice:
nano: 6
units: "units"
totalHoldRecommend: 6
prognosisDate: 2000-01-23T04:56:07.000Z
totalBuyRecommend: 0
properties:
items:
description: "Массив прогнозов."
items:
$ref: "#/components/schemas/GetConsensusForecastsResponseConsensusForecastsItem"
type: "array"
page:
$ref: "#/components/schemas/v1PageResponse"
title: "Консенсус-прогнозы"
type: "object"
v1GetCountriesRequest:
description: "Запрос справочника стран."
type: "object"
v1GetCountriesResponse:
description: "Справочник стран."
example:
countries:
- alfaTwo: "alfaTwo"
alfaThree: "alfaThree"
name: "name"
nameBrief: "nameBrief"
- alfaTwo: "alfaTwo"
alfaThree: "alfaThree"
name: "name"
nameBrief: "nameBrief"
properties:
countries:
description: "Массив стран."
items:
$ref: "#/components/schemas/v1CountryResponse"
type: "array"
type: "object"
v1GetDividendsForeignIssuerReportRequest:
description: "Объект запроса сформированного отчета «Справка о доходах за пределами РФ»."
properties:
taskId:
description: "Идентификатор задачи формирования отчета."
type: "string"
page:
description: "Номер страницы отчета (начинается с 0), значение по умолчанию: 0."
format: "int32"
type: "integer"
required:
- "taskId"
type: "object"
v1GetDividendsForeignIssuerReportResponse:
example:
pagesCount: 6
page: 1
dividendsForeignIssuerReport:
- issuerCountry: "issuerCountry"
externalCommission:
nano: 6
units: "units"
securityName: "securityName"
dividendGross:
nano: 6
units: "units"
quantity: "quantity"
dividendAmount:
nano: 6
units: "units"
recordDate: 2000-01-23T04:56:07.000Z
dividend:
nano: 6
units: "units"
tax:
nano: 6
units: "units"
currency: "currency"
paymentDate: 2000-01-23T04:56:07.000Z
isin: "isin"
- issuerCountry: "issuerCountry"
externalCommission:
nano: 6
units: "units"
securityName: "securityName"
dividendGross:
nano: 6
units: "units"
quantity: "quantity"
dividendAmount:
nano: 6
units: "units"
recordDate: 2000-01-23T04:56:07.000Z
dividend:
nano: 6
units: "units"
tax:
nano: 6
units: "units"
currency: "currency"
paymentDate: 2000-01-23T04:56:07.000Z
isin: "isin"
itemsCount: 0
properties:
dividendsForeignIssuerReport:
items:
$ref: "#/components/schemas/v1DividendsForeignIssuerReport"
type: "array"
itemsCount:
description: "Количество записей в отчете."
format: "int32"
type: "integer"
pagesCount:
description: "Количество страниц с данными отчета, начинается с 0."
format: "int32"
type: "integer"
page:
description: "Текущая страница, начинается с 0."
format: "int32"
type: "integer"
type: "object"
v1GetDividendsForeignIssuerRequest:
properties:
generateDivForeignIssuerReport:
$ref: "#/components/schemas/v1GenerateDividendsForeignIssuerReportRequest"
getDivForeignIssuerReport:
$ref: "#/components/schemas/v1GetDividendsForeignIssuerReportRequest"
type: "object"
v1GetDividendsForeignIssuerResponse:
example:
generateDivForeignIssuerReportResponse:
taskId: "taskId"
divForeignIssuerReport:
pagesCount: 6
page: 1
dividendsForeignIssuerReport:
- issuerCountry: "issuerCountry"
externalCommission:
nano: 6
units: "units"
securityName: "securityName"
dividendGross:
nano: 6
units: "units"
quantity: "quantity"
dividendAmount:
nano: 6
units: "units"
recordDate: 2000-01-23T04:56:07.000Z
dividend:
nano: 6
units: "units"
tax:
nano: 6
units: "units"
currency: "currency"
paymentDate: 2000-01-23T04:56:07.000Z
isin: "isin"
- issuerCountry: "issuerCountry"
externalCommission:
nano: 6
units: "units"
securityName: "securityName"
dividendGross:
nano: 6
units: "units"
quantity: "quantity"
dividendAmount:
nano: 6
units: "units"
recordDate: 2000-01-23T04:56:07.000Z
dividend:
nano: 6
units: "units"
tax:
nano: 6
units: "units"
currency: "currency"
paymentDate: 2000-01-23T04:56:07.000Z
isin: "isin"
itemsCount: 0
properties:
generateDivForeignIssuerReportResponse:
$ref: "#/components/schemas/v1GenerateDividendsForeignIssuerReportResponse"
divForeignIssuerReport:
$ref: "#/components/schemas/v1GetDividendsForeignIssuerReportResponse"
type: "object"
v1GetDividendsRequest:
description: "Запрос дивидендов."
properties:
from:
description: "Начало запрашиваемого периода по UTC. Фильтрация происходит по параметру `record_date` — дата фиксации реестра."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC. Фильтрация происходит по параметру `record_date` — дата фиксации реестра."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
required:
- "instrumentId"
type: "object"
v1GetDividendsResponse:
description: "Дивиденды."
example:
dividends:
- declaredDate: 2000-01-23T04:56:07.000Z
createdAt: 2000-01-23T04:56:07.000Z
recordDate: 2000-01-23T04:56:07.000Z
yieldValue:
nano: 6
units: "units"
closePrice:
nano: 5
currency: "currency"
units: "units"
paymentDate: 2000-01-23T04:56:07.000Z
regularity: "regularity"
dividendNet:
nano: 5
currency: "currency"
units: "units"
lastBuyDate: 2000-01-23T04:56:07.000Z
dividendType: "dividendType"
- declaredDate: 2000-01-23T04:56:07.000Z
createdAt: 2000-01-23T04:56:07.000Z
recordDate: 2000-01-23T04:56:07.000Z
yieldValue:
nano: 6
units: "units"
closePrice:
nano: 5
currency: "currency"
units: "units"
paymentDate: 2000-01-23T04:56:07.000Z
regularity: "regularity"
dividendNet:
nano: 5
currency: "currency"
units: "units"
lastBuyDate: 2000-01-23T04:56:07.000Z
dividendType: "dividendType"
properties:
dividends:
items:
$ref: "#/components/schemas/v1Dividend"
type: "array"
type: "object"
v1GetFavoriteGroupsRequest:
properties:
instrumentId:
description: "Массив идентификаторов инструментов. Принимает значение `figi` или `instrument_uid`. Если в группе будет хотя бы один из инструментов массива, то в ответе у группы вернется признак `containsInstrument = true`."
items:
type: "string"
type: "array"
excludedGroupId:
description: "Массив идентификаторов групп, которые необходимо исключить из ответа."
items:
type: "string"
type: "array"
type: "object"
v1GetFavoriteGroupsResponse:
example:
groups:
- groupName: "groupName"
color: "color"
size: 0
containsInstrument: true
groupId: "groupId"
- groupName: "groupName"
color: "color"
size: 0
containsInstrument: true
groupId: "groupId"
properties:
groups:
description: "Массив групп избранных списков инструментов."
items:
$ref: "#/components/schemas/GetFavoriteGroupsResponseFavoriteGroup"
type: "array"
type: "object"
v1GetFavoritesRequest:
description: "Запрос списка избранных инструментов, входные параметры не требуются."
properties:
groupId:
description: "Уникальный идентификатор группы."
type: "string"
type: "object"
v1GetFavoritesResponse:
description: "В ответ передается список избранных инструментов в качестве массива."
example:
favoriteInstruments:
- otcFlag: true
classCode: "classCode"
uid: "uid"
ticker: "ticker"
instrumentType: "instrumentType"
name: "name"
figi: "figi"
apiTradeAvailableFlag: true
isin: "isin"
- otcFlag: true
classCode: "classCode"
uid: "uid"
ticker: "ticker"
instrumentType: "instrumentType"
name: "name"
figi: "figi"
apiTradeAvailableFlag: true
isin: "isin"
groupId: "groupId"
properties:
favoriteInstruments:
description: "Массив инструментов."
items:
$ref: "#/components/schemas/v1FavoriteInstrument"
type: "array"
groupId:
description: "Уникальный идентификатор группы."
type: "string"
type: "object"
v1GetForecastRequest:
description: "Запрос прогнозов инвестдомов."
properties:
instrumentId:
description: "Идентификатор инструмента."
type: "string"
type: "object"
v1GetForecastResponse:
description: "Прогнозы инвестдомов по инструменту."
example:
consensus:
consensus:
nano: 6
units: "units"
priceChange:
nano: 6
units: "units"
uid: "uid"
maxTarget:
nano: 6
units: "units"
ticker: "ticker"
priceChangeRel:
nano: 6
units: "units"
currentPrice:
nano: 6
units: "units"
currency: "currency"
minTarget:
nano: 6
units: "units"
targets:
- priceChange:
nano: 6
units: "units"
uid: "uid"
ticker: "ticker"
targetPrice:
nano: 6
units: "units"
showName: "showName"
priceChangeRel:
nano: 6
units: "units"
currentPrice:
nano: 6
units: "units"
company: "company"
currency: "currency"
recommendationDate: 2000-01-23T04:56:07.000Z
- priceChange:
nano: 6
units: "units"
uid: "uid"
ticker: "ticker"
targetPrice:
nano: 6
units: "units"
showName: "showName"
priceChangeRel:
nano: 6
units: "units"
currentPrice:
nano: 6
units: "units"
company: "company"
currency: "currency"
recommendationDate: 2000-01-23T04:56:07.000Z
properties:
targets:
description: "Массив прогнозов."
items:
$ref: "#/components/schemas/GetForecastResponseTargetItem"
type: "array"
consensus:
$ref: "#/components/schemas/GetForecastResponseConsensusItem"
type: "object"
v1GetFuturesMarginRequest:
properties:
instrumentId:
description: "Идентификатор инструмента — `figi` или `instrument_uid`."
type: "string"
required:
- "instrumentId"
title: "Запрос информации о фьючерсе"
type: "object"
v1GetFuturesMarginResponse:
example:
initialMarginOnBuy:
nano: 5
currency: "currency"
units: "units"
initialMarginOnSell:
nano: 5
currency: "currency"
units: "units"
minPriceIncrementAmount:
nano: 6
units: "units"
minPriceIncrement:
nano: 6
units: "units"
properties:
initialMarginOnBuy:
$ref: "#/components/schemas/v1MoneyValue"
initialMarginOnSell:
$ref: "#/components/schemas/v1MoneyValue"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
minPriceIncrementAmount:
$ref: "#/components/schemas/v1Quotation"
title: "Данные по фьючерсу"
type: "object"
v1GetInfoRequest:
description: "Запрос информации о пользователе."
type: "object"
v1GetInfoResponse:
description: "Информация о пользователе."
example:
qualifiedForWorkWith:
- "qualifiedForWorkWith"
- "qualifiedForWorkWith"
riskLevelCode: "riskLevelCode"
qualStatus: true
premStatus: true
tariff: "tariff"
userId: "userId"
properties:
premStatus:
description: "Признак премиум клиента."
type: "boolean"
qualStatus:
description: "Признак квалифицированного инвестора."
type: "boolean"
qualifiedForWorkWith:
description: "Набор требующих тестирования инструментов и возможностей, с которыми может работать пользователь. [Подробнее](/invest/services/accounts/faq_users)."
items:
type: "string"
type: "array"
tariff:
description: "Наименование тарифа пользователя."
type: "string"
userId:
description: "Идентификатор пользователя."
type: "string"
riskLevelCode:
description: "Категория риска."
type: "string"
type: "object"
v1GetLastPricesRequest:
description: "Запрос получения цен последних сделок."
properties:
instrumentId:
description: "Массив идентификаторов инструмента. Принимает значения `figi` или `instrument_uid`."
items:
type: "string"
type: "array"
lastPriceType:
$ref: "#/components/schemas/v1LastPriceType"
instrumentStatus:
$ref: "#/components/schemas/v1InstrumentStatus"
type: "object"
v1GetLastPricesResponse:
description: "Список цен последних сделок."
example:
lastPrices:
- price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
- price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
lastPrices:
description: "Массив цен последних сделок."
items:
$ref: "#/components/schemas/v1LastPrice"
type: "array"
type: "object"
v1GetLastTradesRequest:
description: "Запрос обезличенных сделок за последний час."
properties:
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
tradeSource:
$ref: "#/components/schemas/v1TradeSourceType"
required:
- "from"
- "to"
type: "object"
v1GetLastTradesResponse:
description: "Обезличенных сделок за последний час."
example:
trades:
- quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
- quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
trades:
description: "Массив сделок."
items:
$ref: "#/components/schemas/v1Trade"
type: "array"
type: "object"
v1GetMarginAttributesRequest:
description: "Запрос маржинальных показателей по счёту."
properties:
accountId:
description: "Идентификатор счёта пользователя."
type: "string"
required:
- "accountId"
type: "object"
v1GetMarginAttributesResponse:
description: "Маржинальные показатели по счёту."
example:
amountOfMissingFunds:
nano: 5
currency: "currency"
units: "units"
correctedMargin:
nano: 5
currency: "currency"
units: "units"
liquidPortfolio:
nano: 5
currency: "currency"
units: "units"
fundsSufficiencyLevel:
nano: 6
units: "units"
startingMargin:
nano: 5
currency: "currency"
units: "units"
minimalMargin:
nano: 5
currency: "currency"
units: "units"
properties:
liquidPortfolio:
$ref: "#/components/schemas/v1MoneyValue"
startingMargin:
$ref: "#/components/schemas/v1MoneyValue"
minimalMargin:
$ref: "#/components/schemas/v1MoneyValue"
fundsSufficiencyLevel:
$ref: "#/components/schemas/v1Quotation"
amountOfMissingFunds:
$ref: "#/components/schemas/v1MoneyValue"
correctedMargin:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1GetMaxLotsRequest:
description: "Запрос на расчет количества доступных для покупки/продажи лотов. Если не указывать цену инструмента, то расчет произведется по текущум ценам в стакане: по лучшему предложению для покупки и по лучшему спросу для продажи."
properties:
accountId:
title: "Номер счета"
type: "string"
instrumentId:
title: "Идентификатор инструмента, принимает значения Figi или instrument_uid"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
required:
- "accountId"
- "instrumentId"
type: "object"
v1GetMaxLotsResponse:
example:
sellLimits:
sellMaxLots: "sellMaxLots"
buyLimits:
buyMoneyAmount:
nano: 6
units: "units"
buyMaxLots: "buyMaxLots"
buyMaxMarketLots: "buyMaxMarketLots"
currency: "currency"
buyMarginLimits:
buyMoneyAmount:
nano: 6
units: "units"
buyMaxLots: "buyMaxLots"
buyMaxMarketLots: "buyMaxMarketLots"
sellMarginLimits:
sellMaxLots: "sellMaxLots"
properties:
currency:
title: "Валюта инструмента"
type: "string"
buyLimits:
$ref: "#/components/schemas/GetMaxLotsResponseBuyLimitsView"
buyMarginLimits:
$ref: "#/components/schemas/GetMaxLotsResponseBuyLimitsView"
sellLimits:
$ref: "#/components/schemas/GetMaxLotsResponseSellLimitsView"
sellMarginLimits:
$ref: "#/components/schemas/GetMaxLotsResponseSellLimitsView"
title: "Результат количество доступных для покупки/продажи лотов"
type: "object"
v1GetMySubscriptions:
description: "Запрос активных подписок. Возвращает по одному сообщению на каждый тип активных подписок — `SubscribeLastPriceResponse`, `SubscribeInfoResponse`, `SubscribeTradesResponse`, `SubscribeOrderBookResponse`, `SubscribeCandlesResponse`."
type: "object"
v1GetOperationsByCursorRequest:
description: "Запрос списка операций по счету с пагинацией."
properties:
accountId:
description: "Идентификатор счета клиента, обязательный параметр. Остальные параметры опциональны."
type: "string"
instrumentId:
description: "Идентификатор инструмента — FIGI или UID инструмента."
type: "string"
from:
description: "Начало периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание периода по UTC."
format: "date-time"
type: "string"
cursor:
description: "Идентификатор элемента, с которого начать формировать ответ."
type: "string"
limit:
description: "Лимит количества операций. По умолчанию — `100`, максимальное значение — `1000`."
format: "int32"
type: "integer"
operationTypes:
description: "Тип операции. Принимает значение из списка `OperationType`."
items:
$ref: "#/components/schemas/v1OperationType"
type: "array"
state:
$ref: "#/components/schemas/v1OperationState"
withoutCommissions:
description: "Флаг возврата комиссии. По умолчанию — `false`."
type: "boolean"
withoutTrades:
description: "Флаг получения ответа без массива сделок."
type: "boolean"
withoutOvernights:
description: "Флаг показа overnight операций."
type: "boolean"
required:
- "accountId"
type: "object"
v1GetOperationsByCursorResponse:
description: "Список операций по счету с пагинацией."
example:
nextCursor: "nextCursor"
hasNext: true
items:
- cursor: "cursor"
date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
brokerAccountId: "brokerAccountId"
accruedInt:
nano: 5
currency: "currency"
units: "units"
description: "description"
figi: "figi"
cancelDateTime: 2000-01-23T04:56:07.000Z
tradesInfo:
trades:
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
yield:
nano: 5
currency: "currency"
units: "units"
payment:
nano: 5
currency: "currency"
units: "units"
commission:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
cancelReason: "cancelReason"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
positionUid: "positionUid"
quantityDone: "quantityDone"
yieldRelative:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
name: "name"
- cursor: "cursor"
date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
brokerAccountId: "brokerAccountId"
accruedInt:
nano: 5
currency: "currency"
units: "units"
description: "description"
figi: "figi"
cancelDateTime: 2000-01-23T04:56:07.000Z
tradesInfo:
trades:
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
yield:
nano: 5
currency: "currency"
units: "units"
payment:
nano: 5
currency: "currency"
units: "units"
commission:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
cancelReason: "cancelReason"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
positionUid: "positionUid"
quantityDone: "quantityDone"
yieldRelative:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
name: "name"
properties:
hasNext:
description: "Признак, есть ли следующий элемент."
type: "boolean"
nextCursor:
description: "Следующий курсор."
type: "string"
items:
description: "Список операций."
items:
$ref: "#/components/schemas/v1OperationItem"
type: "array"
type: "object"
v1GetOrderBookRequest:
description: "Запрос стакана."
properties:
depth:
description: "Глубина стакана."
format: "int32"
type: "integer"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
required:
- "depth"
type: "object"
v1GetOrderBookResponse:
description: "Информация о стакане."
example:
depth: 0
lastPriceTs: 2000-01-23T04:56:07.000Z
asks:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
orderbookTs: 2000-01-23T04:56:07.000Z
instrumentUid: "instrumentUid"
bids:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
limitUp:
nano: 6
units: "units"
figi: "figi"
closePrice:
nano: 6
units: "units"
limitDown:
nano: 6
units: "units"
closePriceTs: 2000-01-23T04:56:07.000Z
lastPrice:
nano: 6
units: "units"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
depth:
description: "Глубина стакана."
format: "int32"
type: "integer"
bids:
description: "Множество пар значений на покупку."
items:
$ref: "#/components/schemas/v1Order"
type: "array"
asks:
description: "Множество пар значений на продажу."
items:
$ref: "#/components/schemas/v1Order"
type: "array"
lastPrice:
$ref: "#/components/schemas/v1Quotation"
closePrice:
$ref: "#/components/schemas/v1Quotation"
limitUp:
$ref: "#/components/schemas/v1Quotation"
limitDown:
$ref: "#/components/schemas/v1Quotation"
lastPriceTs:
description: "Время получения цены последней сделки."
format: "date-time"
type: "string"
closePriceTs:
description: "Время получения цены закрытия."
format: "date-time"
type: "string"
orderbookTs:
description: "Время формирования стакана на бирже."
format: "date-time"
type: "string"
instrumentUid:
description: "UID инструмента."
type: "string"
type: "object"
v1GetOrderPriceRequest:
properties:
accountId:
title: "Номер счета"
type: "string"
instrumentId:
title: "Идентификатор инструмента, принимает значения Figi или instrument_uid"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
direction:
$ref: "#/components/schemas/v1OrderDirection"
quantity:
format: "int64"
title: "Количество лотов"
type: "string"
title: "Запрос получения предварительной стоимости заявки"
type: "object"
v1GetOrderPriceResponse:
example:
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
initialOrderAmount:
nano: 5
currency: "currency"
units: "units"
dealCommission:
nano: 5
currency: "currency"
units: "units"
extraFuture:
initialMargin:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
executedCommission:
nano: 5
currency: "currency"
units: "units"
executedCommissionRub:
nano: 5
currency: "currency"
units: "units"
serviceCommission:
nano: 5
currency: "currency"
units: "units"
extraBond:
aciValue:
nano: 5
currency: "currency"
units: "units"
nominalConversionRate:
nano: 6
units: "units"
properties:
totalOrderAmount:
$ref: "#/components/schemas/v1MoneyValue"
initialOrderAmount:
$ref: "#/components/schemas/v1MoneyValue"
lotsRequested:
format: "int64"
title: "Запрошено лотов"
type: "string"
executedCommission:
$ref: "#/components/schemas/v1MoneyValue"
executedCommissionRub:
$ref: "#/components/schemas/v1MoneyValue"
serviceCommission:
$ref: "#/components/schemas/v1MoneyValue"
dealCommission:
$ref: "#/components/schemas/v1MoneyValue"
extraBond:
$ref: "#/components/schemas/GetOrderPriceResponseExtraBond"
extraFuture:
$ref: "#/components/schemas/GetOrderPriceResponseExtraFuture"
title: "Предварительная стоимость заявки"
type: "object"
v1GetOrderStateRequest:
description: "Запрос получения статуса торгового поручения."
properties:
accountId:
description: "Номер счета."
type: "string"
orderId:
description: "Идентификатор заявки."
type: "string"
priceType:
$ref: "#/components/schemas/v1PriceType"
orderIdType:
$ref: "#/components/schemas/v1OrderIdType"
required:
- "accountId"
- "orderId"
type: "object"
v1GetOrdersRequest:
description: "Запрос получения списка активных торговых поручений."
properties:
accountId:
description: "Номер счета."
type: "string"
required:
- "accountId"
type: "object"
v1GetOrdersResponse:
description: "Список активных торговых поручений."
example:
orders:
- orderId: "orderId"
figi: "figi"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
initialCommission:
nano: 5
currency: "currency"
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
lotsExecuted: "lotsExecuted"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
stages:
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
orderRequestId: "orderRequestId"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
executedCommission:
nano: 5
currency: "currency"
units: "units"
initialSecurityPrice:
nano: 5
currency: "currency"
units: "units"
serviceCommission:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
orderDate: 2000-01-23T04:56:07.000Z
- orderId: "orderId"
figi: "figi"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
initialCommission:
nano: 5
currency: "currency"
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
lotsExecuted: "lotsExecuted"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
stages:
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
orderRequestId: "orderRequestId"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
executedCommission:
nano: 5
currency: "currency"
units: "units"
initialSecurityPrice:
nano: 5
currency: "currency"
units: "units"
serviceCommission:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
orderDate: 2000-01-23T04:56:07.000Z
properties:
orders:
description: "Массив активных заявок."
items:
$ref: "#/components/schemas/contractv1OrderState"
type: "array"
type: "object"
v1GetSignalsRequest:
description: "Запрос сигналов."
properties:
signalId:
description: "Идентификатор сигнала."
type: "string"
strategyId:
description: "Идентификатор стратегии."
type: "string"
strategyType:
$ref: "#/components/schemas/v1StrategyType"
instrumentUid:
description: "Идентификатор бумаги."
type: "string"
from:
description: "Дата начала запрашиваемого интервала по UTC."
format: "date-time"
type: "string"
to:
description: "Дата конца запрашиваемого интервала по UTC."
format: "date-time"
type: "string"
direction:
$ref: "#/components/schemas/v1SignalDirection"
active:
$ref: "#/components/schemas/v1SignalState"
paging:
$ref: "#/components/schemas/v1Page"
type: "object"
v1GetSignalsResponse:
description: "Сигналы."
example:
signals:
- strategyName: "strategyName"
stoploss:
nano: 6
units: "units"
initialPrice:
nano: 6
units: "units"
probability: 0
endDt: 2000-01-23T04:56:07.000Z
createDt: 2000-01-23T04:56:07.000Z
closeDt: 2000-01-23T04:56:07.000Z
targetPrice:
nano: 6
units: "units"
signalId: "signalId"
instrumentUid: "instrumentUid"
name: "name"
strategyId: "strategyId"
closePrice:
nano: 6
units: "units"
info: "info"
- strategyName: "strategyName"
stoploss:
nano: 6
units: "units"
initialPrice:
nano: 6
units: "units"
probability: 0
endDt: 2000-01-23T04:56:07.000Z
createDt: 2000-01-23T04:56:07.000Z
closeDt: 2000-01-23T04:56:07.000Z
targetPrice:
nano: 6
units: "units"
signalId: "signalId"
instrumentUid: "instrumentUid"
name: "name"
strategyId: "strategyId"
closePrice:
nano: 6
units: "units"
info: "info"
paging:
pageNumber: 6
limit: 0
totalCount: 1
properties:
signals:
description: "Массив сигналов."
items:
$ref: "#/components/schemas/v1Signal"
type: "array"
paging:
$ref: "#/components/schemas/v1PageResponse"
type: "object"
v1GetStopOrdersRequest:
description: "Запрос получения списка активных стоп-заявок."
properties:
accountId:
description: "Идентификатор счета клиента."
type: "string"
status:
$ref: "#/components/schemas/v1StopOrderStatusOption"
from:
description: "Левая граница."
format: "date-time"
type: "string"
to:
description: "Правая граница."
format: "date-time"
type: "string"
required:
- "accountId"
type: "object"
v1GetStopOrdersResponse:
description: "Список активных стоп-заявок."
example:
stopOrders:
- activationDateTime: 2000-01-23T04:56:07.000Z
figi: "figi"
trailingData:
indent:
nano: 6
units: "units"
price:
nano: 6
units: "units"
extr:
nano: 6
units: "units"
spread:
nano: 6
units: "units"
stopPrice:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
expirationTime: 2000-01-23T04:56:07.000Z
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
stopOrderId: "stopOrderId"
createDate: 2000-01-23T04:56:07.000Z
exchangeOrderId: "exchangeOrderId"
- activationDateTime: 2000-01-23T04:56:07.000Z
figi: "figi"
trailingData:
indent:
nano: 6
units: "units"
price:
nano: 6
units: "units"
extr:
nano: 6
units: "units"
spread:
nano: 6
units: "units"
stopPrice:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
expirationTime: 2000-01-23T04:56:07.000Z
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
stopOrderId: "stopOrderId"
createDate: 2000-01-23T04:56:07.000Z
exchangeOrderId: "exchangeOrderId"
properties:
stopOrders:
description: "Массив стоп-заявок по счету."
items:
$ref: "#/components/schemas/v1StopOrder"
type: "array"
type: "object"
v1GetStrategiesRequest:
description: "Запрос стратегий."
properties:
strategyId:
description: "Идентификатор стратегии."
type: "string"
type: "object"
v1GetStrategiesResponse:
example:
strategies:
- strategyName: "strategyName"
strategyDescription: "strategyDescription"
averageSignalYield:
nano: 6
units: "units"
strategyUrl: "strategyUrl"
yieldYear:
nano: 6
units: "units"
yield:
nano: 6
units: "units"
strategyId: "strategyId"
totalSignals: 6
timeInPosition: "timeInPosition"
averageSignalYieldYear:
nano: 6
units: "units"
activeSignals: 0
- strategyName: "strategyName"
strategyDescription: "strategyDescription"
averageSignalYield:
nano: 6
units: "units"
strategyUrl: "strategyUrl"
yieldYear:
nano: 6
units: "units"
yield:
nano: 6
units: "units"
strategyId: "strategyId"
totalSignals: 6
timeInPosition: "timeInPosition"
averageSignalYieldYear:
nano: 6
units: "units"
activeSignals: 0
properties:
strategies:
items:
$ref: "#/components/schemas/v1Strategy"
type: "array"
title: "Стратегии"
type: "object"
v1GetTechAnalysisRequest:
properties:
indicatorType:
$ref: "#/components/schemas/GetTechAnalysisRequestIndicatorType"
instrumentUid:
description: "UID инструмента."
type: "string"
from:
description: "Начало запрашиваемого периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание запрашиваемого периода по UTC."
format: "date-time"
type: "string"
interval:
$ref: "#/components/schemas/GetTechAnalysisRequestIndicatorInterval"
typeOfPrice:
$ref: "#/components/schemas/GetTechAnalysisRequestTypeOfPrice"
length:
description: "Торговый период, за который рассчитывается индикатор."
format: "int32"
type: "integer"
deviation:
$ref: "#/components/schemas/GetTechAnalysisRequestDeviation"
smoothing:
$ref: "#/components/schemas/GetTechAnalysisRequestSmoothing"
required:
- "from"
- "indicatorType"
- "instrumentUid"
- "interval"
- "to"
- "typeOfPrice"
type: "object"
v1GetTechAnalysisResponse:
example:
technicalIndicators:
- lowerBand:
nano: 6
units: "units"
upperBand:
nano: 6
units: "units"
macd:
nano: 6
units: "units"
signal:
nano: 6
units: "units"
timestamp: 2000-01-23T04:56:07.000Z
middleBand:
nano: 6
units: "units"
- lowerBand:
nano: 6
units: "units"
upperBand:
nano: 6
units: "units"
macd:
nano: 6
units: "units"
signal:
nano: 6
units: "units"
timestamp: 2000-01-23T04:56:07.000Z
middleBand:
nano: 6
units: "units"
properties:
technicalIndicators:
description: "Массив значений результатов технического анализа."
items:
$ref: "#/components/schemas/GetTechAnalysisResponseTechAnalysisItem"
type: "array"
type: "object"
v1GetTradingStatusRequest:
description: "Запрос получения торгового статуса."
properties:
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1GetTradingStatusResponse:
description: "Информация о торговом статусе."
example:
limitOrderAvailableFlag: true
bestpriceOrderAvailableFlag: true
onlyBestPrice: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
apiTradeAvailableFlag: true
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
limitOrderAvailableFlag:
description: "Признак доступности выставления лимитной заявки по инструменту."
type: "boolean"
marketOrderAvailableFlag:
description: "Признак доступности выставления рыночной заявки по инструменту."
type: "boolean"
apiTradeAvailableFlag:
description: "Признак доступности торгов через API."
type: "boolean"
instrumentUid:
description: "UID инструмента."
type: "string"
bestpriceOrderAvailableFlag:
description: "Признак доступности завяки по лучшей цене."
type: "boolean"
onlyBestPrice:
description: "Признак доступности только заявки по лучшей цене."
type: "boolean"
type: "object"
v1GetTradingStatusesRequest:
description: "Запрос получения торгового статуса."
properties:
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
items:
type: "string"
type: "array"
type: "object"
v1GetTradingStatusesResponse:
description: "Информация о торговом статусе."
example:
tradingStatuses:
- limitOrderAvailableFlag: true
bestpriceOrderAvailableFlag: true
onlyBestPrice: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
apiTradeAvailableFlag: true
- limitOrderAvailableFlag: true
bestpriceOrderAvailableFlag: true
onlyBestPrice: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
apiTradeAvailableFlag: true
properties:
tradingStatuses:
description: "Массив информации о торговых статусах."
items:
$ref: "#/components/schemas/v1GetTradingStatusResponse"
type: "array"
type: "object"
v1GetUserTariffRequest:
description: "Запрос текущих лимитов пользователя."
type: "object"
v1GetUserTariffResponse:
description: "Текущие лимиты пользователя."
example:
unaryLimits:
- limitPerMinute: 0
methods:
- "methods"
- "methods"
- limitPerMinute: 0
methods:
- "methods"
- "methods"
streamLimits:
- streams:
- "streams"
- "streams"
limit: 6
open: 1
- streams:
- "streams"
- "streams"
limit: 6
open: 1
properties:
unaryLimits:
description: "Массив лимитов пользователя по unary-запросам."
items:
$ref: "#/components/schemas/v1UnaryLimit"
type: "array"
streamLimits:
description: "Массив лимитов пользователей для stream-соединений."
items:
$ref: "#/components/schemas/v1StreamLimit"
type: "array"
type: "object"
v1HistoricCandle:
description: "Информация о свече."
example:
volume: "volume"
high:
nano: 6
units: "units"
low:
nano: 6
units: "units"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
isComplete: true
properties:
open:
$ref: "#/components/schemas/v1Quotation"
high:
$ref: "#/components/schemas/v1Quotation"
low:
$ref: "#/components/schemas/v1Quotation"
close:
$ref: "#/components/schemas/v1Quotation"
volume:
description: "Объем торгов в лотах."
format: "int64"
type: "string"
time:
description: "Время свечи в часовом поясе UTC."
format: "date-time"
type: "string"
isComplete:
description: "Признак завершенности свечи. **false** — свеча за текущие интервал еще сформирована не полностью."
type: "boolean"
candleSource:
$ref: "#/components/schemas/contractv1CandleSource"
type: "object"
v1IndicativeResponse:
example:
classCode: "classCode"
uid: "uid"
ticker: "ticker"
name: "name"
sellAvailableFlag: true
figi: "figi"
currency: "currency"
exchange: "exchange"
buyAvailableFlag: true
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код инструмента."
type: "string"
currency:
description: "Валюта расчетов."
type: "string"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
title: "Индикатив"
type: "object"
v1IndicativesRequest:
title: "Запрос справочника индексов и товаров"
type: "object"
v1IndicativesResponse:
example:
instruments:
- classCode: "classCode"
uid: "uid"
ticker: "ticker"
name: "name"
sellAvailableFlag: true
figi: "figi"
currency: "currency"
exchange: "exchange"
buyAvailableFlag: true
- classCode: "classCode"
uid: "uid"
ticker: "ticker"
name: "name"
sellAvailableFlag: true
figi: "figi"
currency: "currency"
exchange: "exchange"
buyAvailableFlag: true
properties:
instruments:
description: "Массив инструментов."
items:
$ref: "#/components/schemas/v1IndicativeResponse"
type: "array"
title: "Справочник индексов и товаров"
type: "object"
v1InfoInstrument:
description: "Запрос подписки на торговый статус."
properties:
figi:
description: "Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`."
type: "string"
deprecated: true
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1InfoSubscription:
description: "Статус подписки."
example:
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
subscriptionStatus:
$ref: "#/components/schemas/v1SubscriptionStatus"
instrumentUid:
description: "UID инструмента."
type: "string"
streamId:
description: "Идентификатор открытого соединения."
type: "string"
subscriptionId:
description: "Идентификатор подписки в формате UUID."
type: "string"
type: "object"
v1Instrument:
description: "Объект передачи основной информации об инструменте."
example:
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
instrumentType: "instrumentType"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код инструмента."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
lot:
description: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)."
format: "int32"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций в шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Параметр указывает на возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
assetUid:
description: "Уникальный идентификатор актива."
type: "string"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
brand:
$ref: "#/components/schemas/v1BrandData"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1InstrumentClosePriceRequest:
description: "Запрос цен закрытия торговой сессии по инструменту."
properties:
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1InstrumentClosePriceResponse:
description: "Цена закрытия торговой сессии по инструменту."
example:
eveningSessionPrice:
nano: 6
units: "units"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
figi:
description: "FIGI инструмента."
type: "string"
instrumentUid:
description: "UID инструмента."
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
eveningSessionPrice:
$ref: "#/components/schemas/v1Quotation"
time:
description: "Дата совершения торгов."
format: "date-time"
type: "string"
type: "object"
v1InstrumentExchangeType:
default: "INSTRUMENT_EXCHANGE_UNSPECIFIED"
description: "Площадка торговли.\n\n - INSTRUMENT_EXCHANGE_UNSPECIFIED: Площадка торговли не определена.\n - INSTRUMENT_EXCHANGE_DEALER: Бумага, торгуемая у дилера."
enum:
- "INSTRUMENT_EXCHANGE_UNSPECIFIED"
- "INSTRUMENT_EXCHANGE_DEALER"
type: "string"
v1InstrumentIdType:
default: "INSTRUMENT_ID_UNSPECIFIED"
description: "Тип идентификатора инструмента. [Подробнее об идентификации инструментов](./faq_identification/).\n\n - INSTRUMENT_ID_UNSPECIFIED: Значение не определено.\n - INSTRUMENT_ID_TYPE_FIGI: FIGI.\n - INSTRUMENT_ID_TYPE_TICKER: Ticker.\n - INSTRUMENT_ID_TYPE_UID: Уникальный идентификатор.\n - INSTRUMENT_ID_TYPE_POSITION_UID: Идентификатор позиции."
enum:
- "INSTRUMENT_ID_UNSPECIFIED"
- "INSTRUMENT_ID_TYPE_FIGI"
- "INSTRUMENT_ID_TYPE_TICKER"
- "INSTRUMENT_ID_TYPE_UID"
- "INSTRUMENT_ID_TYPE_POSITION_UID"
type: "string"
v1InstrumentLink:
description: "Связь с другим инструментом."
example:
instrumentUid: "instrumentUid"
type: "type"
properties:
type:
description: "Тип связи."
type: "string"
instrumentUid:
description: "UID-идентификатор связанного инструмента."
type: "string"
type: "object"
v1InstrumentRequest:
description: "Запрос получения инструмента по идентификатору."
properties:
idType:
$ref: "#/components/schemas/v1InstrumentIdType"
classCode:
description: "Идентификатор `class_code`. Обязательный, если `id_type = ticker`."
type: "string"
id:
description: "Идентификатор запрашиваемого инструмента."
type: "string"
required:
- "id"
- "idType"
type: "object"
v1InstrumentResponse:
description: "Данные по инструменту."
example:
instrument:
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
instrumentType: "instrumentType"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
isin: "isin"
properties:
instrument:
$ref: "#/components/schemas/v1Instrument"
type: "object"
v1InstrumentShort:
description: "Краткая информация об инструменте."
example:
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
instrumentType: "instrumentType"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
figi: "figi"
apiTradeAvailableFlag: true
first1minCandleDate: 2000-01-23T04:56:07.000Z
lot: 0
uid: "uid"
blockedTcaFlag: true
name: "name"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
isin: "isin"
properties:
isin:
description: "ISIN инструмента."
type: "string"
figi:
description: "FIGI инструмента."
type: "string"
ticker:
description: "Ticker инструмента."
type: "string"
classCode:
description: "ClassCode инструмента."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
name:
description: "Название инструмента."
type: "string"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
apiTradeAvailableFlag:
description: "Возможность торговать инструментом через API."
type: "boolean"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
lot:
description: "Количество бумаг в лоте."
format: "int32"
type: "integer"
type: "object"
v1InstrumentStatus:
default: "INSTRUMENT_STATUS_UNSPECIFIED"
description: "Статус запрашиваемых инструментов.\n\n - INSTRUMENT_STATUS_UNSPECIFIED: Значение не определено.\n - INSTRUMENT_STATUS_BASE: По умолчанию — базовый список инструментов, которыми можно торговать через T-Invest API. Сейчас списки доступных бумаг в API и других интерфейсах совпадают — кроме внебиржевых бумаг, но в будущем списки могут различаться.\n - INSTRUMENT_STATUS_ALL: Список всех инструментов."
enum:
- "INSTRUMENT_STATUS_UNSPECIFIED"
- "INSTRUMENT_STATUS_BASE"
- "INSTRUMENT_STATUS_ALL"
type: "string"
v1InstrumentType:
default: "INSTRUMENT_TYPE_UNSPECIFIED"
description: "Тип инструмента.\n\n - INSTRUMENT_TYPE_BOND: Облигация.\n - INSTRUMENT_TYPE_SHARE: Акция.\n - INSTRUMENT_TYPE_CURRENCY: Валюта.\n - INSTRUMENT_TYPE_ETF: Exchange-traded fund. Фонд.\n - INSTRUMENT_TYPE_FUTURES: Фьючерс.\n - INSTRUMENT_TYPE_SP: Структурная нота.\n - INSTRUMENT_TYPE_OPTION: Опцион.\n - INSTRUMENT_TYPE_CLEARING_CERTIFICATE: Clearing certificate.\n - INSTRUMENT_TYPE_INDEX: Индекс.\n - INSTRUMENT_TYPE_COMMODITY: Товар."
enum:
- "INSTRUMENT_TYPE_UNSPECIFIED"
- "INSTRUMENT_TYPE_BOND"
- "INSTRUMENT_TYPE_SHARE"
- "INSTRUMENT_TYPE_CURRENCY"
- "INSTRUMENT_TYPE_ETF"
- "INSTRUMENT_TYPE_FUTURES"
- "INSTRUMENT_TYPE_SP"
- "INSTRUMENT_TYPE_OPTION"
- "INSTRUMENT_TYPE_CLEARING_CERTIFICATE"
- "INSTRUMENT_TYPE_INDEX"
- "INSTRUMENT_TYPE_COMMODITY"
type: "string"
v1InstrumentsRequest:
description: "Запрос получения инструментов."
properties:
instrumentStatus:
$ref: "#/components/schemas/v1InstrumentStatus"
instrumentExchange:
$ref: "#/components/schemas/v1InstrumentExchangeType"
type: "object"
v1LastPrice:
description: "Информация о цене последней сделки."
example:
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
figi:
description: "FIGI инструмента."
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
time:
description: "Время получения последней цены в часовом поясе UTC по времени биржи."
format: "date-time"
type: "string"
instrumentUid:
description: "UID инструмента."
type: "string"
lastPriceType:
$ref: "#/components/schemas/v1LastPriceType"
type: "object"
v1LastPriceInstrument:
description: "Запрос подписки на последнюю цену."
properties:
figi:
description: "Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`."
type: "string"
deprecated: true
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1LastPriceSubscription:
description: "Статус подписки на цену последней сделки."
example:
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
subscriptionStatus:
$ref: "#/components/schemas/v1SubscriptionStatus"
instrumentUid:
description: "UID инструмента."
type: "string"
streamId:
description: "Идентификатор открытого соединения."
type: "string"
subscriptionId:
description: "Идентификатор подписки в формате `UUID`."
type: "string"
type: "object"
v1LastPriceType:
default: "LAST_PRICE_UNSPECIFIED"
description: "- LAST_PRICE_UNSPECIFIED: Не определен.\n - LAST_PRICE_EXCHANGE: Цена биржи.\n - LAST_PRICE_DEALER: Цена дилера"
enum:
- "LAST_PRICE_UNSPECIFIED"
- "LAST_PRICE_EXCHANGE"
- "LAST_PRICE_DEALER"
title: "Тип последней цены"
type: "string"
v1MarketDataRequest:
description: "Запрос подписки или отписки на определенные биржевые данные."
properties:
subscribeCandlesRequest:
$ref: "#/components/schemas/v1SubscribeCandlesRequest"
subscribeOrderBookRequest:
$ref: "#/components/schemas/v1SubscribeOrderBookRequest"
subscribeTradesRequest:
$ref: "#/components/schemas/v1SubscribeTradesRequest"
subscribeInfoRequest:
$ref: "#/components/schemas/v1SubscribeInfoRequest"
subscribeLastPriceRequest:
$ref: "#/components/schemas/v1SubscribeLastPriceRequest"
getMySubscriptions:
description: "Запрос активных подписок. Возвращает по одному сообщению на каждый тип активных подписок — `SubscribeLastPriceResponse`, `SubscribeInfoResponse`, `SubscribeTradesResponse`, `SubscribeOrderBookResponse`, `SubscribeCandlesResponse`."
type: "object"
ping:
$ref: "#/components/schemas/v1PingRequest"
pingSettings:
$ref: "#/components/schemas/v1PingDelaySettings"
type: "object"
v1MarketDataResponse:
description: "Пакет биржевой информации по подписке."
example:
subscribeInfoResponse:
infoSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
trade:
quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
subscribeOrderBookResponse:
orderBookSubscriptions:
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
candle:
volume: "volume"
high:
nano: 6
units: "units"
lastTradeTs: 2000-01-23T04:56:07.000Z
low:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
orderbook:
depth: 6
asks:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
bids:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
limitUp:
nano: 6
units: "units"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
limitDown:
nano: 6
units: "units"
isConsistent: true
subscribeTradesResponse:
tradeSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
tradingStatus:
limitOrderAvailableFlag: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
subscribeCandlesResponse:
candlesSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
subscribeLastPriceResponse:
lastPriceSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
lastPrice:
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
subscribeCandlesResponse:
$ref: "#/components/schemas/v1SubscribeCandlesResponse"
subscribeOrderBookResponse:
$ref: "#/components/schemas/v1SubscribeOrderBookResponse"
subscribeTradesResponse:
$ref: "#/components/schemas/v1SubscribeTradesResponse"
subscribeInfoResponse:
$ref: "#/components/schemas/v1SubscribeInfoResponse"
candle:
$ref: "#/components/schemas/v1Candle"
trade:
$ref: "#/components/schemas/v1Trade"
orderbook:
$ref: "#/components/schemas/v1OrderBook"
tradingStatus:
$ref: "#/components/schemas/v1TradingStatus"
ping:
$ref: "#/components/schemas/v1Ping"
subscribeLastPriceResponse:
$ref: "#/components/schemas/v1SubscribeLastPriceResponse"
lastPrice:
$ref: "#/components/schemas/v1LastPrice"
type: "object"
v1MarketDataServerSideStreamRequest:
properties:
subscribeCandlesRequest:
$ref: "#/components/schemas/v1SubscribeCandlesRequest"
subscribeOrderBookRequest:
$ref: "#/components/schemas/v1SubscribeOrderBookRequest"
subscribeTradesRequest:
$ref: "#/components/schemas/v1SubscribeTradesRequest"
subscribeInfoRequest:
$ref: "#/components/schemas/v1SubscribeInfoRequest"
subscribeLastPriceRequest:
$ref: "#/components/schemas/v1SubscribeLastPriceRequest"
pingSettings:
$ref: "#/components/schemas/v1PingDelaySettings"
type: "object"
v1MoneyValue:
description: "Денежная сумма в определенной валюте."
example:
nano: 5
currency: "currency"
units: "units"
properties:
currency:
description: "Строковый ISO-код валюты."
type: "string"
units:
description: "Целая часть суммы, может быть отрицательным числом."
format: "int64"
type: "string"
nano:
description: "Дробная часть суммы, может быть отрицательным числом."
format: "int32"
type: "integer"
type: "object"
v1OpenSandboxAccountRequest:
description: "Запрос открытия счета в песочнице."
properties:
name:
title: "Название счета"
type: "string"
type: "object"
v1OpenSandboxAccountResponse:
description: "Номер открытого счета в песочнице."
example:
accountId: "accountId"
properties:
accountId:
title: "Номер счета"
type: "string"
type: "object"
v1Operation:
description: "Данные по операции."
example:
date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
positionUid: "positionUid"
figi: "figi"
type: "type"
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
payment:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
properties:
id:
description: "Идентификатор операции."
type: "string"
parentOperationId:
description: "Идентификатор родительской операции."
type: "string"
currency:
description: "Валюта операции."
type: "string"
payment:
$ref: "#/components/schemas/v1MoneyValue"
price:
$ref: "#/components/schemas/v1MoneyValue"
state:
$ref: "#/components/schemas/v1OperationState"
quantity:
description: "Количество единиц инструмента."
format: "int64"
type: "string"
quantityRest:
description: "Неисполненный остаток по сделке."
format: "int64"
type: "string"
figi:
description: "FIGI-идентификатор инструмента, связанного с операцией."
type: "string"
instrumentType:
description: "Тип инструмента. Возможные значения: <br/><br/>`bond` — облигация; <br/>`share` — акция; <br/>`currency` — валюта; <br/>`etf` — фонд; <br/>`futures` — фьючерс."
type: "string"
date:
description: "Дата и время операции в формате часовом поясе UTC."
format: "date-time"
type: "string"
type:
description: "Текстовое описание типа операции."
type: "string"
operationType:
$ref: "#/components/schemas/v1OperationType"
trades:
description: "Массив сделок."
items:
$ref: "#/components/schemas/v1OperationTrade"
type: "array"
assetUid:
title: "Идентификатор актива"
type: "string"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
childOperations:
description: "Массив дочерних операций."
items:
$ref: "#/components/schemas/v1ChildOperationItem"
type: "array"
type: "object"
v1OperationItem:
description: "Данные об операции."
example:
cursor: "cursor"
date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
brokerAccountId: "brokerAccountId"
accruedInt:
nano: 5
currency: "currency"
units: "units"
description: "description"
figi: "figi"
cancelDateTime: 2000-01-23T04:56:07.000Z
tradesInfo:
trades:
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
yield:
nano: 5
currency: "currency"
units: "units"
payment:
nano: 5
currency: "currency"
units: "units"
commission:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
cancelReason: "cancelReason"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
positionUid: "positionUid"
quantityDone: "quantityDone"
yieldRelative:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
name: "name"
properties:
cursor:
description: "Курсор."
type: "string"
brokerAccountId:
description: "Номер счета клиента."
type: "string"
id:
description: "Идентификатор операции, может меняться с течением времени."
type: "string"
parentOperationId:
description: "Идентификатор родительской операции. Может измениться, если изменился ID родительской операции."
type: "string"
name:
description: "Название операции."
type: "string"
date:
description: "Дата поручения."
format: "date-time"
type: "string"
type:
$ref: "#/components/schemas/v1OperationType"
description:
description: "Описание операции."
type: "string"
state:
$ref: "#/components/schemas/v1OperationState"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
figi:
description: "FIGI."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
instrumentKind:
$ref: "#/components/schemas/v1InstrumentType"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
payment:
$ref: "#/components/schemas/v1MoneyValue"
price:
$ref: "#/components/schemas/v1MoneyValue"
commission:
$ref: "#/components/schemas/v1MoneyValue"
yield:
$ref: "#/components/schemas/v1MoneyValue"
yieldRelative:
$ref: "#/components/schemas/v1Quotation"
accruedInt:
$ref: "#/components/schemas/v1MoneyValue"
quantity:
description: "Количество единиц инструмента."
format: "int64"
type: "string"
quantityRest:
description: "Неисполненный остаток по сделке."
format: "int64"
type: "string"
quantityDone:
description: "Исполненный остаток."
format: "int64"
type: "string"
cancelDateTime:
description: "Дата и время снятия заявки."
format: "date-time"
type: "string"
cancelReason:
description: "Причина отмены операции."
type: "string"
tradesInfo:
$ref: "#/components/schemas/v1OperationItemTrades"
assetUid:
description: "Идентификатор актива."
type: "string"
childOperations:
description: "Массив дочерних операций."
items:
$ref: "#/components/schemas/v1ChildOperationItem"
type: "array"
type: "object"
v1OperationItemTrade:
description: "Сделка по операции."
example:
date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
properties:
num:
description: "Номер сделки."
type: "string"
date:
description: "Дата сделки."
format: "date-time"
type: "string"
quantity:
description: "Количество в единицах."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1MoneyValue"
yield:
$ref: "#/components/schemas/v1MoneyValue"
yieldRelative:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1OperationItemTrades:
description: "Массив с информацией о сделках."
example:
trades:
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
- date: 2000-01-23T04:56:07.000Z
quantity: "quantity"
yieldRelative:
nano: 6
units: "units"
price:
nano: 5
currency: "currency"
units: "units"
num: "num"
yield:
nano: 5
currency: "currency"
units: "units"
properties:
trades:
items:
$ref: "#/components/schemas/v1OperationItemTrade"
type: "array"
type: "object"
v1OperationState:
default: "OPERATION_STATE_UNSPECIFIED"
description: "Статус запрашиваемых операций.\n\n - OPERATION_STATE_UNSPECIFIED: Статус операции не определен.\n - OPERATION_STATE_EXECUTED: Исполнена частично или полностью.\n - OPERATION_STATE_CANCELED: Отменена.\n - OPERATION_STATE_PROGRESS: Исполняется."
enum:
- "OPERATION_STATE_UNSPECIFIED"
- "OPERATION_STATE_EXECUTED"
- "OPERATION_STATE_CANCELED"
- "OPERATION_STATE_PROGRESS"
type: "string"
v1OperationTrade:
description: "Сделка по операции."
example:
dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
properties:
tradeId:
description: "Идентификатор сделки."
type: "string"
dateTime:
description: "Дата и время сделки по UTC."
format: "date-time"
type: "string"
quantity:
description: "Количество инструментов."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1OperationType:
default: "OPERATION_TYPE_UNSPECIFIED"
description: "Тип операции.\n\n - OPERATION_TYPE_UNSPECIFIED: Тип операции не определен.\n - OPERATION_TYPE_INPUT: Пополнение брокерского счета.\n - OPERATION_TYPE_BOND_TAX: Удержание НДФЛ по купонам.\n - OPERATION_TYPE_OUTPUT_SECURITIES: Вывод ЦБ.\n - OPERATION_TYPE_OVERNIGHT: Доход по сделке РЕПО овернайт.\n - OPERATION_TYPE_TAX: Удержание налога.\n - OPERATION_TYPE_BOND_REPAYMENT_FULL: Полное погашение облигаций.\n - OPERATION_TYPE_SELL_CARD: Продажа ЦБ с карты.\n - OPERATION_TYPE_DIVIDEND_TAX: Удержание налога по дивидендам.\n - OPERATION_TYPE_OUTPUT: Вывод денежных средств.\n - OPERATION_TYPE_BOND_REPAYMENT: Частичное погашение облигаций.\n - OPERATION_TYPE_TAX_CORRECTION: Корректировка налога.\n - OPERATION_TYPE_SERVICE_FEE: Удержание комиссии за обслуживание брокерского счета.\n - OPERATION_TYPE_BENEFIT_TAX: Удержание налога за материальную выгоду.\n - OPERATION_TYPE_MARGIN_FEE: Удержание комиссии за непокрытую позицию.\n - OPERATION_TYPE_BUY: Покупка ЦБ.\n - OPERATION_TYPE_BUY_CARD: Покупка ЦБ с карты.\n - OPERATION_TYPE_INPUT_SECURITIES: Перевод ценных бумаг из другого депозитария.\n - OPERATION_TYPE_SELL_MARGIN: Продажа в результате Margin-call.\n - OPERATION_TYPE_BROKER_FEE: Удержание комиссии за операцию.\n - OPERATION_TYPE_BUY_MARGIN: Покупка в результате Margin-call.\n - OPERATION_TYPE_DIVIDEND: Выплата дивидендов.\n - OPERATION_TYPE_SELL: Продажа ЦБ.\n - OPERATION_TYPE_COUPON: Выплата купонов.\n - OPERATION_TYPE_SUCCESS_FEE: Удержание комиссии SuccessFee.\n - OPERATION_TYPE_DIVIDEND_TRANSFER: Передача дивидендного дохода.\n - OPERATION_TYPE_ACCRUING_VARMARGIN: Зачисление вариационной маржи.\n - OPERATION_TYPE_WRITING_OFF_VARMARGIN: Списание вариационной маржи.\n - OPERATION_TYPE_DELIVERY_BUY: Покупка в рамках экспирации фьючерсного контракта.\n - OPERATION_TYPE_DELIVERY_SELL: Продажа в рамках экспирации фьючерсного контракта.\n - OPERATION_TYPE_TRACK_MFEE: Комиссия за управление по счету автоследования.\n - OPERATION_TYPE_TRACK_PFEE: Комиссия за результат по счету автоследования.\n - OPERATION_TYPE_TAX_PROGRESSIVE: Удержание налога по ставке 15%.\n - OPERATION_TYPE_BOND_TAX_PROGRESSIVE: Удержание налога по купонам по ставке 15%.\n - OPERATION_TYPE_DIVIDEND_TAX_PROGRESSIVE: Удержание налога по дивидендам по ставке 15%.\n - OPERATION_TYPE_BENEFIT_TAX_PROGRESSIVE: Удержание налога за материальную выгоду по ставке 15%.\n - OPERATION_TYPE_TAX_CORRECTION_PROGRESSIVE: Корректировка налога по ставке 15%.\n - OPERATION_TYPE_TAX_REPO_PROGRESSIVE: Удержание налога за возмещение по сделкам РЕПО по ставке 15%.\n - OPERATION_TYPE_TAX_REPO: Удержание налога за возмещение по сделкам РЕПО.\n - OPERATION_TYPE_TAX_REPO_HOLD: Удержание налога по сделкам РЕПО.\n - OPERATION_TYPE_TAX_REPO_REFUND: Возврат налога по сделкам РЕПО.\n - OPERATION_TYPE_TAX_REPO_HOLD_PROGRESSIVE: Удержание налога по сделкам РЕПО по ставке 15%.\n - OPERATION_TYPE_TAX_REPO_REFUND_PROGRESSIVE: Возврат налога по сделкам РЕПО по ставке 15%.\n - OPERATION_TYPE_DIV_EXT: Выплата дивидендов на карту.\n - OPERATION_TYPE_TAX_CORRECTION_COUPON: Корректировка налога по купонам.\n - OPERATION_TYPE_CASH_FEE: Комиссия за валютный остаток.\n - OPERATION_TYPE_OUT_FEE: Комиссия за вывод валюты с брокерского счета.\n - OPERATION_TYPE_OUT_STAMP_DUTY: Гербовый сбор.\n - OPERATION_TYPE_OUTPUT_SWIFT: SWIFT-перевод.\n - OPERATION_TYPE_INPUT_SWIFT: SWIFT-перевод.\n - OPERATION_TYPE_OUTPUT_ACQUIRING: Перевод на карту.\n - OPERATION_TYPE_INPUT_ACQUIRING: Перевод с карты.\n - OPERATION_TYPE_OUTPUT_PENALTY: Комиссия за вывод средств.\n - OPERATION_TYPE_ADVICE_FEE: Списание оплаты за сервис Советов.\n - OPERATION_TYPE_TRANS_IIS_BS: Перевод ценных бумаг с ИИС на брокерский счет.\n - OPERATION_TYPE_TRANS_BS_BS: Перевод ценных бумаг с одного брокерского счета на другой.\n - OPERATION_TYPE_OUT_MULTI: Вывод денежных средств со счета.\n - OPERATION_TYPE_INP_MULTI: Пополнение денежных средств со счета.\n - OPERATION_TYPE_OVER_PLACEMENT: Размещение биржевого овернайта.\n - OPERATION_TYPE_OVER_COM: Списание комиссии.\n - OPERATION_TYPE_OVER_INCOME: Доход от оверанайта.\n - OPERATION_TYPE_OPTION_EXPIRATION: Экспирация опциона.\n - OPERATION_TYPE_FUTURE_EXPIRATION: Экспирация фьючерса."
enum:
- "OPERATION_TYPE_UNSPECIFIED"
- "OPERATION_TYPE_INPUT"
- "OPERATION_TYPE_BOND_TAX"
- "OPERATION_TYPE_OUTPUT_SECURITIES"
- "OPERATION_TYPE_OVERNIGHT"
- "OPERATION_TYPE_TAX"
- "OPERATION_TYPE_BOND_REPAYMENT_FULL"
- "OPERATION_TYPE_SELL_CARD"
- "OPERATION_TYPE_DIVIDEND_TAX"
- "OPERATION_TYPE_OUTPUT"
- "OPERATION_TYPE_BOND_REPAYMENT"
- "OPERATION_TYPE_TAX_CORRECTION"
- "OPERATION_TYPE_SERVICE_FEE"
- "OPERATION_TYPE_BENEFIT_TAX"
- "OPERATION_TYPE_MARGIN_FEE"
- "OPERATION_TYPE_BUY"
- "OPERATION_TYPE_BUY_CARD"
- "OPERATION_TYPE_INPUT_SECURITIES"
- "OPERATION_TYPE_SELL_MARGIN"
- "OPERATION_TYPE_BROKER_FEE"
- "OPERATION_TYPE_BUY_MARGIN"
- "OPERATION_TYPE_DIVIDEND"
- "OPERATION_TYPE_SELL"
- "OPERATION_TYPE_COUPON"
- "OPERATION_TYPE_SUCCESS_FEE"
- "OPERATION_TYPE_DIVIDEND_TRANSFER"
- "OPERATION_TYPE_ACCRUING_VARMARGIN"
- "OPERATION_TYPE_WRITING_OFF_VARMARGIN"
- "OPERATION_TYPE_DELIVERY_BUY"
- "OPERATION_TYPE_DELIVERY_SELL"
- "OPERATION_TYPE_TRACK_MFEE"
- "OPERATION_TYPE_TRACK_PFEE"
- "OPERATION_TYPE_TAX_PROGRESSIVE"
- "OPERATION_TYPE_BOND_TAX_PROGRESSIVE"
- "OPERATION_TYPE_DIVIDEND_TAX_PROGRESSIVE"
- "OPERATION_TYPE_BENEFIT_TAX_PROGRESSIVE"
- "OPERATION_TYPE_TAX_CORRECTION_PROGRESSIVE"
- "OPERATION_TYPE_TAX_REPO_PROGRESSIVE"
- "OPERATION_TYPE_TAX_REPO"
- "OPERATION_TYPE_TAX_REPO_HOLD"
- "OPERATION_TYPE_TAX_REPO_REFUND"
- "OPERATION_TYPE_TAX_REPO_HOLD_PROGRESSIVE"
- "OPERATION_TYPE_TAX_REPO_REFUND_PROGRESSIVE"
- "OPERATION_TYPE_DIV_EXT"
- "OPERATION_TYPE_TAX_CORRECTION_COUPON"
- "OPERATION_TYPE_CASH_FEE"
- "OPERATION_TYPE_OUT_FEE"
- "OPERATION_TYPE_OUT_STAMP_DUTY"
- "OPERATION_TYPE_OUTPUT_SWIFT"
- "OPERATION_TYPE_INPUT_SWIFT"
- "OPERATION_TYPE_OUTPUT_ACQUIRING"
- "OPERATION_TYPE_INPUT_ACQUIRING"
- "OPERATION_TYPE_OUTPUT_PENALTY"
- "OPERATION_TYPE_ADVICE_FEE"
- "OPERATION_TYPE_TRANS_IIS_BS"
- "OPERATION_TYPE_TRANS_BS_BS"
- "OPERATION_TYPE_OUT_MULTI"
- "OPERATION_TYPE_INP_MULTI"
- "OPERATION_TYPE_OVER_PLACEMENT"
- "OPERATION_TYPE_OVER_COM"
- "OPERATION_TYPE_OVER_INCOME"
- "OPERATION_TYPE_OPTION_EXPIRATION"
- "OPERATION_TYPE_FUTURE_EXPIRATION"
type: "string"
v1OperationsRequest:
description: "Запрос получения списка операций по счету."
properties:
accountId:
description: "Идентификатор счета клиента."
type: "string"
from:
description: "Начало периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание периода по UTC."
format: "date-time"
type: "string"
state:
$ref: "#/components/schemas/v1OperationState"
figi:
description: "FIGI-идентификатор инструмента для фильтрации."
type: "string"
required:
- "accountId"
type: "object"
v1OperationsResponse:
description: "Список операций."
example:
operations:
- date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
positionUid: "positionUid"
figi: "figi"
type: "type"
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
payment:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
- date: 2000-01-23T04:56:07.000Z
assetUid: "assetUid"
instrumentType: "instrumentType"
childOperations:
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
- instrumentUid: "instrumentUid"
payment:
nano: 5
currency: "currency"
units: "units"
quantity: "quantity"
parentOperationId: "parentOperationId"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
positionUid: "positionUid"
figi: "figi"
type: "type"
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
payment:
nano: 5
currency: "currency"
units: "units"
id: "id"
quantityRest: "quantityRest"
properties:
operations:
description: "Массив операций."
items:
$ref: "#/components/schemas/v1Operation"
type: "array"
type: "object"
v1Option:
description: "Опцион."
example:
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
settlementCurrency: "settlementCurrency"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
strikePrice:
nano: 5
currency: "currency"
units: "units"
properties:
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код."
type: "string"
basicAssetPositionUid:
description: "Уникальный идентификатор позиции основного инструмента."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
direction:
$ref: "#/components/schemas/v1OptionDirection"
paymentType:
$ref: "#/components/schemas/v1OptionPaymentType"
style:
$ref: "#/components/schemas/v1OptionStyle"
settlementType:
$ref: "#/components/schemas/v1OptionSettlementType"
name:
description: "Название инструмента."
type: "string"
currency:
description: "Валюта."
type: "string"
settlementCurrency:
description: "Валюта, в которой оценивается контракт."
type: "string"
assetType:
description: "Тип актива."
type: "string"
basicAsset:
description: "Основной актив."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
countryOfRisk:
description: "Код страны рисков."
type: "string"
countryOfRiskName:
description: "Наименование страны рисков."
type: "string"
sector:
description: "Сектор экономики."
type: "string"
brand:
$ref: "#/components/schemas/v1BrandData"
lot:
description: "Количество бумаг в лоте."
format: "int32"
type: "integer"
basicAssetSize:
$ref: "#/components/schemas/v1Quotation"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
strikePrice:
$ref: "#/components/schemas/v1MoneyValue"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
expirationDate:
description: "Дата истечения срока в формате UTC."
format: "date-time"
type: "string"
firstTradeDate:
description: "Дата начала обращения контракта в формате UTC."
format: "date-time"
type: "string"
lastTradeDate:
description: "Дата исполнения в формате UTC."
format: "date-time"
type: "string"
first1minCandleDate:
description: "Дата первой минутной свечи в формате UTC."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи в формате UTC."
format: "date-time"
type: "string"
shortEnabledFlag:
description: "Признак доступности для операций шорт."
type: "boolean"
forIisFlag:
description: "Возможность покупки или продажи на ИИС."
type: "boolean"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
apiTradeAvailableFlag:
description: "Возможность торговать инструментом через API."
type: "boolean"
type: "object"
v1OptionDirection:
default: "OPTION_DIRECTION_UNSPECIFIED"
description: "Тип опциона по направлению сделки.\n\n - OPTION_DIRECTION_UNSPECIFIED: Тип не определен.\n - OPTION_DIRECTION_PUT: Опцион на продажу.\n - OPTION_DIRECTION_CALL: Опцион на покупку."
enum:
- "OPTION_DIRECTION_UNSPECIFIED"
- "OPTION_DIRECTION_PUT"
- "OPTION_DIRECTION_CALL"
type: "string"
v1OptionPaymentType:
default: "OPTION_PAYMENT_TYPE_UNSPECIFIED"
description: "Тип расчетов по опциону.\n\n - OPTION_PAYMENT_TYPE_UNSPECIFIED: Тип не определен.\n - OPTION_PAYMENT_TYPE_PREMIUM: Опционы с использованием премии в расчетах.\n - OPTION_PAYMENT_TYPE_MARGINAL: Маржируемые опционы."
enum:
- "OPTION_PAYMENT_TYPE_UNSPECIFIED"
- "OPTION_PAYMENT_TYPE_PREMIUM"
- "OPTION_PAYMENT_TYPE_MARGINAL"
type: "string"
v1OptionResponse:
description: "Данные по опциону."
example:
instrument:
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
settlementCurrency: "settlementCurrency"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
strikePrice:
nano: 5
currency: "currency"
units: "units"
properties:
instrument:
$ref: "#/components/schemas/v1Option"
type: "object"
v1OptionSettlementType:
default: "OPTION_EXECUTION_TYPE_UNSPECIFIED"
description: "Тип опциона по способу исполнения.\n\n - OPTION_EXECUTION_TYPE_UNSPECIFIED: Тип не определен.\n - OPTION_EXECUTION_TYPE_PHYSICAL_DELIVERY: Поставочный тип опциона.\n - OPTION_EXECUTION_TYPE_CASH_SETTLEMENT: Расчетный тип опциона."
enum:
- "OPTION_EXECUTION_TYPE_UNSPECIFIED"
- "OPTION_EXECUTION_TYPE_PHYSICAL_DELIVERY"
- "OPTION_EXECUTION_TYPE_CASH_SETTLEMENT"
type: "string"
v1OptionStyle:
default: "OPTION_STYLE_UNSPECIFIED"
description: "Тип опциона по стилю.\n\n - OPTION_STYLE_UNSPECIFIED: Тип не определен.\n - OPTION_STYLE_AMERICAN: Американский опцион.\n - OPTION_STYLE_EUROPEAN: Европейский опцион."
enum:
- "OPTION_STYLE_UNSPECIFIED"
- "OPTION_STYLE_AMERICAN"
- "OPTION_STYLE_EUROPEAN"
type: "string"
v1OptionsResponse:
description: "Данные по опционам."
example:
instruments:
- dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
settlementCurrency: "settlementCurrency"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
strikePrice:
nano: 5
currency: "currency"
units: "units"
- dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
lastTradeDate: 2000-01-23T04:56:07.000Z
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
expirationDate: 2000-01-23T04:56:07.000Z
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
firstTradeDate: 2000-01-23T04:56:07.000Z
basicAssetSize:
nano: 6
units: "units"
forQualInvestorFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
assetType: "assetType"
minPriceIncrement:
nano: 6
units: "units"
basicAssetPositionUid: "basicAssetPositionUid"
dshortClient:
nano: 6
units: "units"
otcFlag: true
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
settlementCurrency: "settlementCurrency"
name: "name"
basicAsset: "basicAsset"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
strikePrice:
nano: 5
currency: "currency"
units: "units"
properties:
instruments:
description: "Массив данных по опциону."
items:
$ref: "#/components/schemas/v1Option"
type: "array"
type: "object"
v1Order:
description: "Массив предложений/спроса."
example:
quantity: "quantity"
price:
nano: 6
units: "units"
properties:
price:
$ref: "#/components/schemas/v1Quotation"
quantity:
description: "Количество в лотах."
format: "int64"
type: "string"
type: "object"
v1OrderBook:
description: "Пакет стаканов в рамках стрима."
example:
depth: 6
asks:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
bids:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
limitUp:
nano: 6
units: "units"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
limitDown:
nano: 6
units: "units"
isConsistent: true
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
depth:
description: "Глубина стакана."
format: "int32"
type: "integer"
isConsistent:
description: "Флаг консистентности стакана. **false** — не все заявки попали в стакан из-за сетевых задержек или нарушения порядка доставки."
type: "boolean"
bids:
description: "Массив предложений."
items:
$ref: "#/components/schemas/v1Order"
type: "array"
asks:
description: "Массив спроса."
items:
$ref: "#/components/schemas/v1Order"
type: "array"
time:
description: "Время формирования стакана в часовом поясе UTC по времени биржи."
format: "date-time"
type: "string"
limitUp:
$ref: "#/components/schemas/v1Quotation"
limitDown:
$ref: "#/components/schemas/v1Quotation"
instrumentUid:
description: "UID инструмента."
type: "string"
orderBookType:
$ref: "#/components/schemas/v1OrderBookType"
type: "object"
v1OrderBookInstrument:
description: "Запрос подписки на стаканы."
properties:
figi:
description: "Deprecated FIGI-идентификатор инструмента. Используйте `instrument_id`."
type: "string"
deprecated: true
depth:
description: "Глубина стакана."
format: "int32"
type: "integer"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
orderBookType:
$ref: "#/components/schemas/v1OrderBookType"
type: "object"
v1OrderBookSubscription:
description: "Статус подписки."
example:
depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
depth:
description: "Глубина стакана."
format: "int32"
type: "integer"
subscriptionStatus:
$ref: "#/components/schemas/v1SubscriptionStatus"
instrumentUid:
description: "UID инструмента."
type: "string"
streamId:
description: "Идентификатор открытого соединения."
type: "string"
subscriptionId:
description: "Идентификатор подписки в формате `UUID`."
type: "string"
orderBookType:
$ref: "#/components/schemas/v1OrderBookType"
type: "object"
v1OrderBookType:
default: "ORDERBOOK_TYPE_UNSPECIFIED"
description: " - ORDERBOOK_TYPE_UNSPECIFIED: Не определен.\n - ORDERBOOK_TYPE_EXCHANGE: Биржевой стакан.\n - ORDERBOOK_TYPE_DEALER: Стакан дилера.\n - ORDERBOOK_TYPE_ALL: Стакан биржевой и дилера."
enum:
- "ORDERBOOK_TYPE_UNSPECIFIED"
- "ORDERBOOK_TYPE_EXCHANGE"
- "ORDERBOOK_TYPE_DEALER"
- "ORDERBOOK_TYPE_ALL"
type: "string"
v1OrderDirection:
default: "ORDER_DIRECTION_UNSPECIFIED"
description: "Направление операции.\n\n - ORDER_DIRECTION_UNSPECIFIED: Значение не указано\n - ORDER_DIRECTION_BUY: Покупка\n - ORDER_DIRECTION_SELL: Продажа"
enum:
- "ORDER_DIRECTION_UNSPECIFIED"
- "ORDER_DIRECTION_BUY"
- "ORDER_DIRECTION_SELL"
type: "string"
v1OrderExecutionReportStatus:
default: "EXECUTION_REPORT_STATUS_UNSPECIFIED"
description: "- EXECUTION_REPORT_STATUS_FILL: Исполнена\n - EXECUTION_REPORT_STATUS_REJECTED: Отклонена\n - EXECUTION_REPORT_STATUS_CANCELLED: Отменена пользователем\n - EXECUTION_REPORT_STATUS_NEW: Новая\n - EXECUTION_REPORT_STATUS_PARTIALLYFILL: Частично исполнена"
enum:
- "EXECUTION_REPORT_STATUS_UNSPECIFIED"
- "EXECUTION_REPORT_STATUS_FILL"
- "EXECUTION_REPORT_STATUS_REJECTED"
- "EXECUTION_REPORT_STATUS_CANCELLED"
- "EXECUTION_REPORT_STATUS_NEW"
- "EXECUTION_REPORT_STATUS_PARTIALLYFILL"
title: "Текущий статус заявки (поручения)"
type: "string"
v1OrderIdType:
default: "ORDER_ID_TYPE_UNSPECIFIED"
description: "- ORDER_ID_TYPE_UNSPECIFIED: Тип идентификатора не указан.\n - ORDER_ID_TYPE_EXCHANGE: Биржевой идентификатор\n - ORDER_ID_TYPE_REQUEST: Ключ идемпотентности, переданный клиентом"
enum:
- "ORDER_ID_TYPE_UNSPECIFIED"
- "ORDER_ID_TYPE_EXCHANGE"
- "ORDER_ID_TYPE_REQUEST"
title: "Тип идентификатора заявки"
type: "string"
v1OrderStage:
description: "Сделки в рамках торгового поручения."
example:
executionTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 5
currency: "currency"
units: "units"
tradeId: "tradeId"
properties:
price:
$ref: "#/components/schemas/v1MoneyValue"
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
tradeId:
description: "Идентификатор сделки."
type: "string"
executionTime:
format: "date-time"
title: "Время исполнения сделки"
type: "string"
type: "object"
v1OrderStateStreamRequest:
properties:
accounts:
description: "Идентификаторы счетов."
items:
type: "string"
type: "array"
pingDelayMillis:
description: "Задержка (пинг) сообщений: 1000-120 000 миллисекунд. Значение по умолчанию — 120 000."
format: "int32"
type: "integer"
title: "Запрос установки стрим-соединения торговых поручений"
type: "object"
v1OrderStateStreamResponse:
example:
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
subscription:
streamId: "streamId"
accounts:
- "accounts"
- "accounts"
error:
code: "code"
message: "message"
trackingId: "trackingId"
orderState:
orderId: "orderId"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
createdAt: 2000-01-23T04:56:07.000Z
completionTime: 2000-01-23T04:56:07.000Z
lotsLeft: "lotsLeft"
orderPrice:
nano: 5
currency: "currency"
units: "units"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
classCode: "classCode"
ticker: "ticker"
amount:
nano: 5
currency: "currency"
units: "units"
lotSize: 0
lotsCancelled: "lotsCancelled"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
accountId: "accountId"
lotsExecuted: "lotsExecuted"
clientCode: "clientCode"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
orderRequestId: "orderRequestId"
exchange: "exchange"
properties:
orderState:
$ref: "#/components/schemas/v1OrderStateStreamResponseOrderState"
ping:
$ref: "#/components/schemas/v1Ping"
subscription:
$ref: "#/components/schemas/v1SubscriptionResponse"
title: "Информация по заявкам"
type: "object"
v1OrderStateStreamResponseOrderState:
example:
orderId: "orderId"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
createdAt: 2000-01-23T04:56:07.000Z
completionTime: 2000-01-23T04:56:07.000Z
lotsLeft: "lotsLeft"
orderPrice:
nano: 5
currency: "currency"
units: "units"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
classCode: "classCode"
ticker: "ticker"
amount:
nano: 5
currency: "currency"
units: "units"
lotSize: 0
lotsCancelled: "lotsCancelled"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
accountId: "accountId"
lotsExecuted: "lotsExecuted"
clientCode: "clientCode"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
orderRequestId: "orderRequestId"
exchange: "exchange"
properties:
orderId:
description: "Биржевой идентификатор заявки."
type: "string"
orderRequestId:
description: "Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов."
type: "string"
clientCode:
description: "Код клиента на бирже."
type: "string"
createdAt:
description: "Дата создания заявки."
format: "date-time"
type: "string"
executionReportStatus:
$ref: "#/components/schemas/v1OrderExecutionReportStatus"
statusInfo:
$ref: "#/components/schemas/OrderStateStreamResponseStatusCauseInfo"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
lotSize:
description: "Лотность инструмента заявки."
format: "int32"
type: "integer"
direction:
$ref: "#/components/schemas/v1OrderDirection"
timeInForce:
$ref: "#/components/schemas/v1TimeInForceType"
orderType:
$ref: "#/components/schemas/v1OrderType"
accountId:
description: "Номер счета."
type: "string"
initialOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
orderPrice:
$ref: "#/components/schemas/v1MoneyValue"
amount:
$ref: "#/components/schemas/v1MoneyValue"
executedOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
currency:
description: "Валюта исполнения."
type: "string"
lotsRequested:
description: "Запрошено лотов."
format: "int64"
type: "string"
lotsExecuted:
description: "Исполнено лотов."
format: "int64"
type: "string"
lotsLeft:
description: "Число неисполненных лотов по заявке."
format: "int64"
type: "string"
lotsCancelled:
description: "Отмененные лоты."
format: "int64"
type: "string"
marker:
$ref: "#/components/schemas/OrderStateStreamResponseMarkerType"
trades:
description: "Список сделок."
items:
$ref: "#/components/schemas/v1OrderTrade"
type: "array"
completionTime:
description: "Время исполнения заявки."
format: "date-time"
type: "string"
exchange:
description: "Код биржи."
type: "string"
instrumentUid:
description: "UID идентификатор инструмента."
type: "string"
title: "Заявка"
type: "object"
v1OrderTrade:
description: "Информация о сделке."
example:
dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
properties:
dateTime:
description: "Дата и время совершения сделки в часовом поясе UTC."
format: "date-time"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
quantity:
description: "Количество штук в сделке."
format: "int64"
type: "string"
tradeId:
description: "Идентификатор сделки."
type: "string"
type: "object"
v1OrderTrades:
description: "Информация об исполнении торгового поручения."
example:
createdAt: 2000-01-23T04:56:07.000Z
accountId: "accountId"
orderId: "orderId"
instrumentUid: "instrumentUid"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
figi: "figi"
properties:
orderId:
description: "Идентификатор торгового поручения."
type: "string"
createdAt:
description: "Дата и время создания сообщения в часовом поясе UTC."
format: "date-time"
type: "string"
direction:
$ref: "#/components/schemas/v1OrderDirection"
figi:
description: "Figi-идентификатор инструмента."
type: "string"
trades:
description: "Массив сделок."
items:
$ref: "#/components/schemas/v1OrderTrade"
type: "array"
accountId:
description: "Идентификатор счета."
type: "string"
instrumentUid:
description: "UID идентификатор инструмента."
type: "string"
type: "object"
v1OrderType:
default: "ORDER_TYPE_UNSPECIFIED"
description: "Тип заявки.\n\n - ORDER_TYPE_UNSPECIFIED: Значение не указано\n - ORDER_TYPE_LIMIT: Лимитная\n - ORDER_TYPE_MARKET: Рыночная\n - ORDER_TYPE_BESTPRICE: Лучшая цена"
enum:
- "ORDER_TYPE_UNSPECIFIED"
- "ORDER_TYPE_LIMIT"
- "ORDER_TYPE_MARKET"
- "ORDER_TYPE_BESTPRICE"
type: "string"
v1Page:
properties:
limit:
description: "Максимальное число возвращаемых записей."
format: "int32"
type: "integer"
pageNumber:
description: "Порядковый номер страницы, начиная с 0."
format: "int32"
type: "integer"
type: "object"
v1PageResponse:
example:
pageNumber: 6
limit: 0
totalCount: 1
properties:
limit:
description: "Максимальное число возвращаемых записей."
format: "int32"
type: "integer"
pageNumber:
description: "Порядковый номер страницы, начиная с 0."
format: "int32"
type: "integer"
totalCount:
description: "Общее количество записей."
format: "int32"
type: "integer"
type: "object"
v1Ping:
description: "Проверка активности стрима."
example:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
properties:
time:
description: "Время проверки."
format: "date-time"
type: "string"
streamId:
description: "Идентификатор соединения."
type: "string"
pingRequestTime:
description: "Время формирования запроса."
format: "date-time"
type: "string"
type: "object"
v1PingDelaySettings:
properties:
pingDelayMs:
description: "Задержка (пинг) сообщений: 5000–180 000 миллисекунд. Значение по умолчанию — 120 000."
format: "int32"
type: "integer"
type: "object"
v1PingRequest:
properties:
time:
description: "Время формирования запроса."
format: "date-time"
type: "string"
type: "object"
v1PortfolioPosition:
description: "Позиции портфеля."
example:
varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
quantity:
$ref: "#/components/schemas/v1Quotation"
averagePositionPrice:
$ref: "#/components/schemas/v1MoneyValue"
expectedYield:
$ref: "#/components/schemas/v1Quotation"
currentNkd:
$ref: "#/components/schemas/v1MoneyValue"
averagePositionPricePt:
$ref: "#/components/schemas/v1Quotation"
currentPrice:
$ref: "#/components/schemas/v1MoneyValue"
averagePositionPriceFifo:
$ref: "#/components/schemas/v1MoneyValue"
quantityLots:
$ref: "#/components/schemas/v1Quotation"
blocked:
description: "Заблокировано на бирже."
type: "boolean"
blockedLots:
$ref: "#/components/schemas/v1Quotation"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
varMargin:
$ref: "#/components/schemas/v1MoneyValue"
expectedYieldFifo:
$ref: "#/components/schemas/v1Quotation"
dailyYield:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1PortfolioRequest:
description: "Запрос получения текущего портфеля по счету."
properties:
accountId:
description: "Идентификатор счета пользователя."
type: "string"
currency:
$ref: "#/components/schemas/PortfolioRequestCurrencyRequest"
required:
- "accountId"
type: "object"
v1PortfolioResponse:
description: "Текущий портфель по счету."
example:
totalAmountBonds:
nano: 5
currency: "currency"
units: "units"
totalAmountFutures:
nano: 5
currency: "currency"
units: "units"
totalAmountSp:
nano: 5
currency: "currency"
units: "units"
positions:
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountEtf:
nano: 5
currency: "currency"
units: "units"
accountId: "accountId"
totalAmountCurrencies:
nano: 5
currency: "currency"
units: "units"
dailyYield:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountShares:
nano: 5
currency: "currency"
units: "units"
totalAmountPortfolio:
nano: 5
currency: "currency"
units: "units"
virtualPositions:
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
dailyYieldRelative:
nano: 6
units: "units"
totalAmountOptions:
nano: 5
currency: "currency"
units: "units"
properties:
totalAmountShares:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountBonds:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountEtf:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountCurrencies:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountFutures:
$ref: "#/components/schemas/v1MoneyValue"
expectedYield:
$ref: "#/components/schemas/v1Quotation"
positions:
description: "Список позиций портфеля."
items:
$ref: "#/components/schemas/v1PortfolioPosition"
type: "array"
accountId:
description: "Идентификатор счета пользователя."
type: "string"
totalAmountOptions:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountSp:
$ref: "#/components/schemas/v1MoneyValue"
totalAmountPortfolio:
$ref: "#/components/schemas/v1MoneyValue"
virtualPositions:
description: "Массив виртуальных позиций портфеля."
items:
$ref: "#/components/schemas/v1VirtualPortfolioPosition"
type: "array"
dailyYield:
$ref: "#/components/schemas/v1MoneyValue"
dailyYieldRelative:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1PortfolioStreamRequest:
description: "Запрос установки stream-соединения."
properties:
accounts:
description: "Массив идентификаторов счетов пользователя."
items:
type: "string"
type: "array"
pingSettings:
$ref: "#/components/schemas/v1PingDelaySettings"
type: "object"
v1PortfolioStreamResponse:
description: "Информация по позициям и доходностям портфелей."
example:
subscriptions:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
portfolio:
totalAmountBonds:
nano: 5
currency: "currency"
units: "units"
totalAmountFutures:
nano: 5
currency: "currency"
units: "units"
totalAmountSp:
nano: 5
currency: "currency"
units: "units"
positions:
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountEtf:
nano: 5
currency: "currency"
units: "units"
accountId: "accountId"
totalAmountCurrencies:
nano: 5
currency: "currency"
units: "units"
dailyYield:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountShares:
nano: 5
currency: "currency"
units: "units"
totalAmountPortfolio:
nano: 5
currency: "currency"
units: "units"
virtualPositions:
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
dailyYieldRelative:
nano: 6
units: "units"
totalAmountOptions:
nano: 5
currency: "currency"
units: "units"
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
properties:
subscriptions:
$ref: "#/components/schemas/v1PortfolioSubscriptionResult"
portfolio:
$ref: "#/components/schemas/v1PortfolioResponse"
ping:
$ref: "#/components/schemas/v1Ping"
type: "object"
v1PortfolioSubscriptionResult:
description: "Объект результата подписки."
example:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
properties:
accounts:
description: "Массив счетов клиента."
items:
$ref: "#/components/schemas/v1AccountSubscriptionStatus"
type: "array"
trackingId:
description: "Уникальный идентификатор запроса, подробнее: [tracking_id](/invest/intro/developer/protocols/grpc#tracking-id)."
type: "string"
streamId:
title: "Идентификатор открытого соединения"
type: "string"
type: "object"
v1PortfolioSubscriptionStatus:
default: "PORTFOLIO_SUBSCRIPTION_STATUS_UNSPECIFIED"
description: "Результат подписки.\n\n - PORTFOLIO_SUBSCRIPTION_STATUS_UNSPECIFIED: Тип не определен.\n - PORTFOLIO_SUBSCRIPTION_STATUS_SUCCESS: Успешно.\n - PORTFOLIO_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND: Счет не найден или недостаточно прав.\n - PORTFOLIO_SUBSCRIPTION_STATUS_INTERNAL_ERROR: Произошла ошибка."
enum:
- "PORTFOLIO_SUBSCRIPTION_STATUS_UNSPECIFIED"
- "PORTFOLIO_SUBSCRIPTION_STATUS_SUCCESS"
- "PORTFOLIO_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND"
- "PORTFOLIO_SUBSCRIPTION_STATUS_INTERNAL_ERROR"
type: "string"
v1PositionData:
description: "Данные о позиции портфеля."
example:
date: 2000-01-23T04:56:07.000Z
accountId: "accountId"
money:
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
properties:
accountId:
description: "Идентификатор счета."
type: "string"
money:
description: "Массив валютных позиций портфеля."
items:
$ref: "#/components/schemas/v1PositionsMoney"
type: "array"
securities:
description: "Список ценно-бумажных позиций портфеля."
items:
$ref: "#/components/schemas/v1PositionsSecurities"
type: "array"
futures:
description: "Список фьючерсов портфеля."
items:
$ref: "#/components/schemas/v1PositionsFutures"
type: "array"
options:
description: "Список опционов портфеля."
items:
$ref: "#/components/schemas/v1PositionsOptions"
type: "array"
date:
description: "Дата и время операции в формате UTC."
format: "date-time"
type: "string"
type: "object"
v1PositionsAccountSubscriptionStatus:
default: "POSITIONS_SUBSCRIPTION_STATUS_UNSPECIFIED"
description: "Результат подписки.\n\n - POSITIONS_SUBSCRIPTION_STATUS_UNSPECIFIED: Тип не определен.\n - POSITIONS_SUBSCRIPTION_STATUS_SUCCESS: Успешно.\n - POSITIONS_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND: Счет не найден или недостаточно прав.\n - POSITIONS_SUBSCRIPTION_STATUS_INTERNAL_ERROR: Произошла ошибка."
enum:
- "POSITIONS_SUBSCRIPTION_STATUS_UNSPECIFIED"
- "POSITIONS_SUBSCRIPTION_STATUS_SUCCESS"
- "POSITIONS_SUBSCRIPTION_STATUS_ACCOUNT_NOT_FOUND"
- "POSITIONS_SUBSCRIPTION_STATUS_INTERNAL_ERROR"
type: "string"
v1PositionsFutures:
description: "Баланс фьючерса."
example:
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
properties:
figi:
description: "FIGI-идентификатор фьючерса."
type: "string"
blocked:
description: "Количество бумаг, заблокированных выставленными заявками."
format: "int64"
type: "string"
balance:
description: "Текущий незаблокированный баланс."
format: "int64"
type: "string"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
type: "object"
v1PositionsMoney:
description: "Валютная позиция портфеля."
example:
availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
properties:
availableValue:
$ref: "#/components/schemas/v1MoneyValue"
blockedValue:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1PositionsOptions:
description: "Баланс опциона."
example:
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
properties:
positionUid:
description: "Уникальный идентификатор позиции опциона."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
blocked:
description: "Количество бумаг, заблокированных выставленными заявками."
format: "int64"
type: "string"
balance:
description: "Текущий незаблокированный баланс."
format: "int64"
type: "string"
type: "object"
v1PositionsRequest:
description: "Запрос позиций портфеля по счету."
properties:
accountId:
description: "Идентификатор счета пользователя."
type: "string"
required:
- "accountId"
type: "object"
v1PositionsResponse:
description: "Список позиций по счету."
example:
limitsLoadingInProgress: true
accountId: "accountId"
money:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
blocked:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
properties:
money:
description: "Массив валютных позиций портфеля."
items:
$ref: "#/components/schemas/v1MoneyValue"
type: "array"
blocked:
description: "Массив заблокированных валютных позиций портфеля."
items:
$ref: "#/components/schemas/v1MoneyValue"
type: "array"
securities:
description: "Список ценно-бумажных позиций портфеля."
items:
$ref: "#/components/schemas/v1PositionsSecurities"
type: "array"
limitsLoadingInProgress:
description: "Признак идущей выгрузки лимитов в данный момент."
type: "boolean"
futures:
description: "Список фьючерсов портфеля."
items:
$ref: "#/components/schemas/v1PositionsFutures"
type: "array"
options:
description: "Список опционов портфеля."
items:
$ref: "#/components/schemas/v1PositionsOptions"
type: "array"
accountId:
description: "Идентификатор счёта пользователя."
type: "string"
type: "object"
v1PositionsSecurities:
description: "Баланс позиции ценной бумаги."
example:
instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
properties:
figi:
description: "FIGI-идентификатор бумаги."
type: "string"
blocked:
description: "Количество бумаг, заблокированных выставленными заявками."
format: "int64"
type: "string"
balance:
description: "Текущий незаблокированный баланс."
format: "int64"
type: "string"
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
exchangeBlocked:
description: "Заблокировано на бирже."
type: "boolean"
instrumentType:
description: "Тип инструмента."
type: "string"
type: "object"
v1PositionsStreamRequest:
description: "Запрос установки stream-соединения позиций."
properties:
accounts:
description: "Массив идентификаторов счетов пользователя."
items:
type: "string"
type: "array"
withInitialPositions:
description: "Получение состояния позиций на момент подключения."
type: "boolean"
pingSettings:
$ref: "#/components/schemas/v1PingDelaySettings"
type: "object"
v1PositionsStreamResponse:
description: "Информация по изменению позиций портфеля."
example:
subscriptions:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
initialPositions:
limitsLoadingInProgress: true
accountId: "accountId"
money:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
blocked:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
position:
date: 2000-01-23T04:56:07.000Z
accountId: "accountId"
money:
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
properties:
subscriptions:
$ref: "#/components/schemas/v1PositionsSubscriptionResult"
position:
$ref: "#/components/schemas/v1PositionData"
ping:
$ref: "#/components/schemas/v1Ping"
initialPositions:
$ref: "#/components/schemas/v1PositionsResponse"
type: "object"
v1PositionsSubscriptionResult:
description: "Объект результата подписки."
example:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
properties:
accounts:
description: "Массив счетов клиента."
items:
$ref: "#/components/schemas/v1PositionsSubscriptionStatus"
type: "array"
trackingId:
description: "Уникальный идентификатор запроса, подробнее: [tracking_id](/invest/intro/developer/protocols/grpc#tracking-id)."
type: "string"
streamId:
title: "Идентификатор открытого соединения"
type: "string"
type: "object"
v1PositionsSubscriptionStatus:
description: "Счет клиента."
example:
accountId: "accountId"
properties:
accountId:
description: "Идентификатор счета."
type: "string"
subscriptionStatus:
$ref: "#/components/schemas/v1PositionsAccountSubscriptionStatus"
type: "object"
v1PostOrderAsyncRequest:
description: "Запрос выставления асинхронного торгового поручения."
properties:
instrumentId:
description: "Идентификатор инструмента, принимает значения Figi или Instrument_uid."
type: "string"
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
direction:
$ref: "#/components/schemas/v1OrderDirection"
accountId:
description: "Номер счета."
type: "string"
orderType:
$ref: "#/components/schemas/v1OrderType"
orderId:
description: "Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина 36 символов."
type: "string"
timeInForce:
$ref: "#/components/schemas/v1TimeInForceType"
priceType:
$ref: "#/components/schemas/v1PriceType"
required:
- "accountId"
- "direction"
- "instrumentId"
- "orderId"
- "orderType"
- "quantity"
type: "object"
v1PostOrderAsyncResponse:
description: "Результат выставления асинхронного торгового поручения."
example:
tradeIntentId: "tradeIntentId"
orderRequestId: "orderRequestId"
properties:
orderRequestId:
description: "Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов."
type: "string"
executionReportStatus:
$ref: "#/components/schemas/v1OrderExecutionReportStatus"
tradeIntentId:
description: "Идентификатор торгового поручения."
type: "string"
required:
- "executionReportStatus"
- "orderRequestId"
type: "object"
v1PostOrderRequest:
description: "Запрос выставления торгового поручения."
properties:
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
direction:
$ref: "#/components/schemas/v1OrderDirection"
accountId:
description: "Номер счета."
type: "string"
orderType:
$ref: "#/components/schemas/v1OrderType"
orderId:
description: "Идентификатор запроса выставления поручения для целей идемпотентности в формате UID. Максимальная длина 36 символов."
type: "string"
instrumentId:
description: "Идентификатор инструмента, принимает значения Figi или Instrument_uid."
type: "string"
timeInForce:
$ref: "#/components/schemas/v1TimeInForceType"
priceType:
$ref: "#/components/schemas/v1PriceType"
required:
- "accountId"
- "direction"
- "orderId"
- "orderType"
- "quantity"
type: "object"
v1PostOrderResponse:
description: "Информация о выставлении поручения."
example:
orderId: "orderId"
figi: "figi"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
initialCommission:
nano: 5
currency: "currency"
units: "units"
message: "message"
lotsExecuted: "lotsExecuted"
totalOrderAmount:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
initialOrderPricePt:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
orderRequestId: "orderRequestId"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
executedCommission:
nano: 5
currency: "currency"
units: "units"
initialSecurityPrice:
nano: 5
currency: "currency"
units: "units"
aciValue:
nano: 5
currency: "currency"
units: "units"
responseMetadata:
serverTime: 2000-01-23T04:56:07.000Z
trackingId: "trackingId"
properties:
orderId:
description: "Биржевой идентификатор заявки."
type: "string"
executionReportStatus:
$ref: "#/components/schemas/v1OrderExecutionReportStatus"
lotsRequested:
description: "Запрошено лотов."
format: "int64"
type: "string"
lotsExecuted:
description: "Исполнено лотов."
format: "int64"
type: "string"
initialOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
executedOrderPrice:
$ref: "#/components/schemas/v1MoneyValue"
totalOrderAmount:
$ref: "#/components/schemas/v1MoneyValue"
initialCommission:
$ref: "#/components/schemas/v1MoneyValue"
executedCommission:
$ref: "#/components/schemas/v1MoneyValue"
aciValue:
$ref: "#/components/schemas/v1MoneyValue"
figi:
description: "Figi-идентификатор инструмента."
type: "string"
direction:
$ref: "#/components/schemas/v1OrderDirection"
initialSecurityPrice:
$ref: "#/components/schemas/v1MoneyValue"
orderType:
$ref: "#/components/schemas/v1OrderType"
message:
description: "Дополнительные данные об исполнении заявки."
type: "string"
initialOrderPricePt:
$ref: "#/components/schemas/v1Quotation"
instrumentUid:
description: "UID идентификатор инструмента."
type: "string"
orderRequestId:
description: "Идентификатор ключа идемпотентности, переданный клиентом, в формате UID. Максимальная длина 36 символов."
type: "string"
responseMetadata:
$ref: "#/components/schemas/v1ResponseMetadata"
type: "object"
v1PostStopOrderRequest:
description: "Запрос выставления стоп-заявки."
properties:
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
stopPrice:
$ref: "#/components/schemas/v1Quotation"
direction:
$ref: "#/components/schemas/v1StopOrderDirection"
accountId:
description: "Номер счета."
type: "string"
expirationType:
$ref: "#/components/schemas/v1StopOrderExpirationType"
stopOrderType:
$ref: "#/components/schemas/v1StopOrderType"
expireDate:
description: "Дата и время окончания действия стоп-заявки по UTC. Для `ExpirationType = GoodTillDate` заполнение обязательно, для `GoodTillCancel` игнорируется."
format: "date-time"
type: "string"
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
exchangeOrderType:
$ref: "#/components/schemas/v1ExchangeOrderType"
takeProfitType:
$ref: "#/components/schemas/v1TakeProfitType"
trailingData:
$ref: "#/components/schemas/v1PostStopOrderRequestTrailingData"
priceType:
$ref: "#/components/schemas/v1PriceType"
orderId:
description: "Идентификатор запроса выставления поручения для целей идемпотентности в формате `UID`. Максимальная длина — 36 символов."
type: "string"
required:
- "accountId"
- "direction"
- "expirationType"
- "instrumentId"
- "orderId"
- "quantity"
- "stopOrderType"
type: "object"
v1PostStopOrderRequestTrailingData:
properties:
indent:
$ref: "#/components/schemas/v1Quotation"
indentType:
$ref: "#/components/schemas/v1TrailingValueType"
spread:
$ref: "#/components/schemas/v1Quotation"
spreadType:
$ref: "#/components/schemas/v1TrailingValueType"
type: "object"
v1PostStopOrderResponse:
description: "Результат выставления стоп-заявки."
example:
orderRequestId: "orderRequestId"
responseMetadata:
serverTime: 2000-01-23T04:56:07.000Z
trackingId: "trackingId"
stopOrderId: "stopOrderId"
properties:
stopOrderId:
description: "Уникальный идентификатор стоп-заявки."
type: "string"
orderRequestId:
description: "Идентификатор ключа идемпотентности, переданный клиентом, в формате `UID`. Максимальная длина 36 — символов."
type: "string"
responseMetadata:
$ref: "#/components/schemas/v1ResponseMetadata"
type: "object"
v1PriceType:
default: "PRICE_TYPE_UNSPECIFIED"
description: "Тип цены.\n\n - PRICE_TYPE_UNSPECIFIED: Значение не определено.\n - PRICE_TYPE_POINT: Цена в пунктах (только для фьючерсов и облигаций).\n - PRICE_TYPE_CURRENCY: Цена в валюте расчетов по инструменту."
enum:
- "PRICE_TYPE_UNSPECIFIED"
- "PRICE_TYPE_POINT"
- "PRICE_TYPE_CURRENCY"
type: "string"
v1Quotation:
description: "Котировка — денежная сумма без указания валюты."
example:
nano: 6
units: "units"
properties:
units:
description: "Целая часть суммы, может быть отрицательным числом."
format: "int64"
type: "string"
nano:
description: "Дробная часть суммы, может быть отрицательным числом."
format: "int32"
type: "integer"
type: "object"
v1RealExchange:
default: "REAL_EXCHANGE_UNSPECIFIED"
description: "Реальная площадка исполнения расчетов.\n\n - REAL_EXCHANGE_UNSPECIFIED: Тип не определен.\n - REAL_EXCHANGE_MOEX: Московская биржа.\n - REAL_EXCHANGE_RTS: Санкт-Петербургская биржа.\n - REAL_EXCHANGE_OTC: Внебиржевой инструмент.\n - REAL_EXCHANGE_DEALER: Инструмент, торгуемый на площадке брокера."
enum:
- "REAL_EXCHANGE_UNSPECIFIED"
- "REAL_EXCHANGE_MOEX"
- "REAL_EXCHANGE_RTS"
- "REAL_EXCHANGE_OTC"
- "REAL_EXCHANGE_DEALER"
type: "string"
v1Recommendation:
default: "RECOMMENDATION_UNSPECIFIED"
description: " - RECOMMENDATION_UNSPECIFIED: Не определено.\n - RECOMMENDATION_BUY: Покупать.\n - RECOMMENDATION_HOLD: Держать.\n - RECOMMENDATION_SELL: Продавать."
enum:
- "RECOMMENDATION_UNSPECIFIED"
- "RECOMMENDATION_BUY"
- "RECOMMENDATION_HOLD"
- "RECOMMENDATION_SELL"
type: "string"
v1ReplaceOrderRequest:
description: "Запрос изменения выставленной заявки."
properties:
accountId:
description: "Номер счета."
type: "string"
orderId:
description: "Идентификатор заявки на бирже."
type: "string"
idempotencyKey:
description: "Новый идентификатор запроса выставления поручения для целей идемпотентности. Максимальная длина 36 символов. Перезатирает старый ключ."
type: "string"
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
price:
$ref: "#/components/schemas/v1Quotation"
priceType:
$ref: "#/components/schemas/v1PriceType"
required:
- "accountId"
- "idempotencyKey"
- "orderId"
- "quantity"
type: "object"
v1ResponseMetadata:
example:
serverTime: 2000-01-23T04:56:07.000Z
trackingId: "trackingId"
properties:
trackingId:
description: "Идентификатор трекинга."
type: "string"
serverTime:
description: "Серверное время."
format: "date-time"
type: "string"
type: "object"
v1ResultSubscriptionStatus:
default: "RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED"
enum:
- "RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED"
- "RESULT_SUBSCRIPTION_STATUS_OK"
- "RESULT_SUBSCRIPTION_STATUS_ERROR"
title: "- RESULT_SUBSCRIPTION_STATUS_UNSPECIFIED: Статус подписки не определен.\n - RESULT_SUBSCRIPTION_STATUS_OK: Подписка успешно установлена.\n - RESULT_SUBSCRIPTION_STATUS_ERROR: Ошибка подписки"
type: "string"
v1RiskLevel:
default: "RISK_LEVEL_UNSPECIFIED"
description: "Уровень риска облигации.\n\n - RISK_LEVEL_UNSPECIFIED: Не указан.\n - RISK_LEVEL_LOW: Низкий уровень риска.\n - RISK_LEVEL_MODERATE: Средний уровень риска.\n - RISK_LEVEL_HIGH: Высокий уровень риска."
enum:
- "RISK_LEVEL_UNSPECIFIED"
- "RISK_LEVEL_LOW"
- "RISK_LEVEL_MODERATE"
- "RISK_LEVEL_HIGH"
type: "string"
v1RiskRatesRequest:
properties:
instrumentId:
description: "Идентификаторы инструментов."
items:
type: "string"
type: "array"
type: "object"
v1RiskRatesResponse:
example:
instrumentRiskRates:
- longRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
longRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
error: "error"
- longRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
longRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRates:
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
- riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
shortRiskRate:
riskLevelCode: "riskLevelCode"
value:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
error: "error"
properties:
instrumentRiskRates:
items:
$ref: "#/components/schemas/RiskRatesResponseRiskRateResult"
type: "array"
type: "object"
v1SandboxPayInRequest:
description: "Запрос пополнения счета в песочнице."
properties:
accountId:
title: "Номер счета"
type: "string"
amount:
$ref: "#/components/schemas/v1MoneyValue"
required:
- "accountId"
- "amount"
type: "object"
v1SandboxPayInResponse:
description: "Результат пополнения счета, текущий баланс."
example:
balance:
nano: 5
currency: "currency"
units: "units"
properties:
balance:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1SecurityTradingStatus:
default: "SECURITY_TRADING_STATUS_UNSPECIFIED"
description: "- SECURITY_TRADING_STATUS_UNSPECIFIED: Торговый статус не определен.\n - SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING: Недоступен для торгов.\n - SECURITY_TRADING_STATUS_OPENING_PERIOD: Период открытия торгов.\n - SECURITY_TRADING_STATUS_CLOSING_PERIOD: Период закрытия торгов.\n - SECURITY_TRADING_STATUS_BREAK_IN_TRADING: Перерыв в торговле.\n - SECURITY_TRADING_STATUS_NORMAL_TRADING: Нормальная торговля.\n - SECURITY_TRADING_STATUS_CLOSING_AUCTION: Аукцион закрытия.\n - SECURITY_TRADING_STATUS_DARK_POOL_AUCTION: Аукцион крупных пакетов.\n - SECURITY_TRADING_STATUS_DISCRETE_AUCTION: Дискретный аукцион.\n - SECURITY_TRADING_STATUS_OPENING_AUCTION_PERIOD: Аукцион открытия.\n - SECURITY_TRADING_STATUS_TRADING_AT_CLOSING_AUCTION_PRICE: Период торгов по цене аукциона закрытия.\n - SECURITY_TRADING_STATUS_SESSION_ASSIGNED: Сессия назначена.\n - SECURITY_TRADING_STATUS_SESSION_CLOSE: Сессия закрыта.\n - SECURITY_TRADING_STATUS_SESSION_OPEN: Сессия открыта.\n - SECURITY_TRADING_STATUS_DEALER_NORMAL_TRADING: Доступна торговля в режиме внутренней ликвидности брокера.\n - SECURITY_TRADING_STATUS_DEALER_BREAK_IN_TRADING: Перерыв торговли в режиме внутренней ликвидности брокера.\n - SECURITY_TRADING_STATUS_DEALER_NOT_AVAILABLE_FOR_TRADING: Недоступна торговля в режиме внутренней ликвидности брокера."
enum:
- "SECURITY_TRADING_STATUS_UNSPECIFIED"
- "SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING"
- "SECURITY_TRADING_STATUS_OPENING_PERIOD"
- "SECURITY_TRADING_STATUS_CLOSING_PERIOD"
- "SECURITY_TRADING_STATUS_BREAK_IN_TRADING"
- "SECURITY_TRADING_STATUS_NORMAL_TRADING"
- "SECURITY_TRADING_STATUS_CLOSING_AUCTION"
- "SECURITY_TRADING_STATUS_DARK_POOL_AUCTION"
- "SECURITY_TRADING_STATUS_DISCRETE_AUCTION"
- "SECURITY_TRADING_STATUS_OPENING_AUCTION_PERIOD"
- "SECURITY_TRADING_STATUS_TRADING_AT_CLOSING_AUCTION_PRICE"
- "SECURITY_TRADING_STATUS_SESSION_ASSIGNED"
- "SECURITY_TRADING_STATUS_SESSION_CLOSE"
- "SECURITY_TRADING_STATUS_SESSION_OPEN"
- "SECURITY_TRADING_STATUS_DEALER_NORMAL_TRADING"
- "SECURITY_TRADING_STATUS_DEALER_BREAK_IN_TRADING"
- "SECURITY_TRADING_STATUS_DEALER_NOT_AVAILABLE_FOR_TRADING"
title: "Режим торгов инструмента"
type: "string"
v1Share:
description: "Объект передачи информации об акции."
example:
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
issueSize: "issueSize"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
divYieldFlag: true
isin: "isin"
ipoDate: 2000-01-23T04:56:07.000Z
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
ticker:
description: "Тикер инструмента."
type: "string"
classCode:
description: "Класс-код (секция торгов)."
type: "string"
isin:
description: "ISIN-идентификатор инструмента."
type: "string"
lot:
format: "int32"
title: "Лотность инструмента. Возможно совершение операций только на количества ценной бумаги, кратные параметру `lot`. [Подробнее](./glossary#lot)"
type: "integer"
currency:
description: "Валюта расчетов."
type: "string"
klong:
$ref: "#/components/schemas/v1Quotation"
kshort:
$ref: "#/components/schemas/v1Quotation"
dlong:
$ref: "#/components/schemas/v1Quotation"
dshort:
$ref: "#/components/schemas/v1Quotation"
dlongMin:
$ref: "#/components/schemas/v1Quotation"
dshortMin:
$ref: "#/components/schemas/v1Quotation"
shortEnabledFlag:
description: "Признак доступности для операций в шорт."
type: "boolean"
name:
description: "Название инструмента."
type: "string"
exchange:
description: "Tорговая площадка (секция биржи)."
type: "string"
ipoDate:
description: "Дата IPO акции по UTC."
format: "date-time"
type: "string"
issueSize:
description: "Размер выпуска."
format: "int64"
type: "string"
countryOfRisk:
description: "Код страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
countryOfRiskName:
description: "Наименование страны риска — то есть страны, в которой компания ведет основной бизнес."
type: "string"
sector:
description: "Сектор экономики."
type: "string"
issueSizePlan:
description: "Плановый размер выпуска."
format: "int64"
type: "string"
nominal:
$ref: "#/components/schemas/v1MoneyValue"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
otcFlag:
description: "Флаг, используемый ранее для определения внебиржевых инструментов. На данный момент не используется для торгуемых через API инструментов. Может использоваться как фильтр для операций, совершавшихся некоторое время назад на ОТС площадке."
type: "boolean"
buyAvailableFlag:
description: "Признак доступности для покупки."
type: "boolean"
sellAvailableFlag:
description: "Признак доступности для продажи."
type: "boolean"
divYieldFlag:
description: "Признак наличия дивидендной доходности."
type: "boolean"
shareType:
$ref: "#/components/schemas/v1ShareType"
minPriceIncrement:
$ref: "#/components/schemas/v1Quotation"
apiTradeAvailableFlag:
description: "Возможность торговать инструментом через API."
type: "boolean"
uid:
description: "Уникальный идентификатор инструмента."
type: "string"
realExchange:
$ref: "#/components/schemas/v1RealExchange"
positionUid:
description: "Уникальный идентификатор позиции инструмента."
type: "string"
assetUid:
description: "Уникальный идентификатор актива."
type: "string"
instrumentExchange:
$ref: "#/components/schemas/v1InstrumentExchangeType"
forIisFlag:
description: "Признак доступности для ИИС."
type: "boolean"
forQualInvestorFlag:
description: "Флаг, отображающий доступность торговли инструментом только для квалифицированных инвесторов."
type: "boolean"
weekendFlag:
description: "Флаг, отображающий доступность торговли инструментом по выходным."
type: "boolean"
blockedTcaFlag:
description: "Флаг заблокированного ТКС."
type: "boolean"
liquidityFlag:
description: "Флаг достаточной ликвидности."
type: "boolean"
first1minCandleDate:
description: "Дата первой минутной свечи."
format: "date-time"
type: "string"
first1dayCandleDate:
description: "Дата первой дневной свечи."
format: "date-time"
type: "string"
brand:
$ref: "#/components/schemas/v1BrandData"
dlongClient:
$ref: "#/components/schemas/v1Quotation"
dshortClient:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1ShareResponse:
description: "Данные по акции."
example:
instrument:
assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
issueSize: "issueSize"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
divYieldFlag: true
isin: "isin"
ipoDate: 2000-01-23T04:56:07.000Z
properties:
instrument:
$ref: "#/components/schemas/v1Share"
type: "object"
v1ShareType:
default: "SHARE_TYPE_UNSPECIFIED"
description: "Тип акций.\n\n - SHARE_TYPE_UNSPECIFIED: Значение не определено.\n - SHARE_TYPE_COMMON: Обыкновенная.\n - SHARE_TYPE_PREFERRED: Привилегированная.\n - SHARE_TYPE_ADR: Американские депозитарные расписки.\n - SHARE_TYPE_GDR: Глобальные депозитарные расписки.\n - SHARE_TYPE_MLP: Товарищество с ограниченной ответственностью.\n - SHARE_TYPE_NY_REG_SHRS: Акции из реестра Нью-Йорка.\n - SHARE_TYPE_CLOSED_END_FUND: Закрытый инвестиционный фонд.\n - SHARE_TYPE_REIT: Траст недвижимости."
enum:
- "SHARE_TYPE_UNSPECIFIED"
- "SHARE_TYPE_COMMON"
- "SHARE_TYPE_PREFERRED"
- "SHARE_TYPE_ADR"
- "SHARE_TYPE_GDR"
- "SHARE_TYPE_MLP"
- "SHARE_TYPE_NY_REG_SHRS"
- "SHARE_TYPE_CLOSED_END_FUND"
- "SHARE_TYPE_REIT"
type: "string"
v1SharesResponse:
description: "Данные по акциям."
example:
instruments:
- assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
issueSize: "issueSize"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
divYieldFlag: true
isin: "isin"
ipoDate: 2000-01-23T04:56:07.000Z
- assetUid: "assetUid"
figi: "figi"
dshortMin:
nano: 6
units: "units"
countryOfRisk: "countryOfRisk"
lot: 0
uid: "uid"
blockedTcaFlag: true
dlong:
nano: 6
units: "units"
dlongClient:
nano: 6
units: "units"
nominal:
nano: 5
currency: "currency"
units: "units"
sellAvailableFlag: true
currency: "currency"
first1dayCandleDate: 2000-01-23T04:56:07.000Z
sector: "sector"
brand:
logoName: "logoName"
logoBaseColor: "logoBaseColor"
textColor: "textColor"
buyAvailableFlag: true
weekendFlag: true
classCode: "classCode"
ticker: "ticker"
forQualInvestorFlag: true
liquidityFlag: true
forIisFlag: true
positionUid: "positionUid"
apiTradeAvailableFlag: true
dlongMin:
nano: 6
units: "units"
shortEnabledFlag: true
kshort:
nano: 6
units: "units"
first1minCandleDate: 2000-01-23T04:56:07.000Z
issueSizePlan: "issueSizePlan"
minPriceIncrement:
nano: 6
units: "units"
otcFlag: true
dshortClient:
nano: 6
units: "units"
klong:
nano: 6
units: "units"
dshort:
nano: 6
units: "units"
name: "name"
issueSize: "issueSize"
exchange: "exchange"
countryOfRiskName: "countryOfRiskName"
divYieldFlag: true
isin: "isin"
ipoDate: 2000-01-23T04:56:07.000Z
properties:
instruments:
description: "Массив акций."
items:
$ref: "#/components/schemas/v1Share"
type: "array"
type: "object"
v1Signal:
description: "Сигнал."
example:
strategyName: "strategyName"
stoploss:
nano: 6
units: "units"
initialPrice:
nano: 6
units: "units"
probability: 0
endDt: 2000-01-23T04:56:07.000Z
createDt: 2000-01-23T04:56:07.000Z
closeDt: 2000-01-23T04:56:07.000Z
targetPrice:
nano: 6
units: "units"
signalId: "signalId"
instrumentUid: "instrumentUid"
name: "name"
strategyId: "strategyId"
closePrice:
nano: 6
units: "units"
info: "info"
properties:
signalId:
description: "Идентификатор сигнала."
type: "string"
strategyId:
description: "Идентификатор стратегии."
type: "string"
strategyName:
description: "Название стратегии."
type: "string"
instrumentUid:
description: "Идентификатор бумаги."
type: "string"
createDt:
description: "Дата и время создания сигнала по UTC."
format: "date-time"
type: "string"
direction:
$ref: "#/components/schemas/v1SignalDirection"
initialPrice:
$ref: "#/components/schemas/v1Quotation"
info:
description: "Дополнительная информация о сигнале."
type: "string"
name:
description: "Название сигнала."
type: "string"
targetPrice:
$ref: "#/components/schemas/v1Quotation"
endDt:
description: "Дата и время дедлайна сигнала по UTC."
format: "date-time"
type: "string"
probability:
description: "Вероятность сигнала."
format: "int32"
type: "integer"
stoploss:
$ref: "#/components/schemas/v1Quotation"
closePrice:
$ref: "#/components/schemas/v1Quotation"
closeDt:
description: "Дата и время закрытия сигнала по UTC."
format: "date-time"
type: "string"
required:
- "createDt"
- "direction"
- "endDt"
- "initialPrice"
- "instrumentUid"
- "name"
- "signalId"
- "strategyId"
- "strategyName"
- "targetPrice"
type: "object"
v1SignalDirection:
default: "SIGNAL_DIRECTION_UNSPECIFIED"
description: "Направление сигнала.\n\n - SIGNAL_DIRECTION_UNSPECIFIED: Не определен.\n - SIGNAL_DIRECTION_BUY: Покупка.\n - SIGNAL_DIRECTION_SELL: Продажа."
enum:
- "SIGNAL_DIRECTION_UNSPECIFIED"
- "SIGNAL_DIRECTION_BUY"
- "SIGNAL_DIRECTION_SELL"
type: "string"
v1SignalState:
default: "SIGNAL_STATE_UNSPECIFIED"
description: "Статус сигнала.\n\n - SIGNAL_STATE_UNSPECIFIED: Не определен.\n - SIGNAL_STATE_ACTIVE: Активный сигнал.\n - SIGNAL_STATE_CLOSED: Закрытый сигнал.\n - SIGNAL_STATE_ALL: Все состояния."
enum:
- "SIGNAL_STATE_UNSPECIFIED"
- "SIGNAL_STATE_ACTIVE"
- "SIGNAL_STATE_CLOSED"
- "SIGNAL_STATE_ALL"
type: "string"
v1StopOrder:
description: "Информация о стоп-заявке."
example:
activationDateTime: 2000-01-23T04:56:07.000Z
figi: "figi"
trailingData:
indent:
nano: 6
units: "units"
price:
nano: 6
units: "units"
extr:
nano: 6
units: "units"
spread:
nano: 6
units: "units"
stopPrice:
nano: 5
currency: "currency"
units: "units"
lotsRequested: "lotsRequested"
expirationTime: 2000-01-23T04:56:07.000Z
price:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
currency: "currency"
stopOrderId: "stopOrderId"
createDate: 2000-01-23T04:56:07.000Z
exchangeOrderId: "exchangeOrderId"
properties:
stopOrderId:
description: "Уникальный идентификатор стоп-заявки."
type: "string"
lotsRequested:
description: "Запрошено лотов."
format: "int64"
type: "string"
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
direction:
$ref: "#/components/schemas/v1StopOrderDirection"
currency:
description: "Валюта стоп-заявки."
type: "string"
orderType:
$ref: "#/components/schemas/v1StopOrderType"
createDate:
description: "Дата и время выставления заявки по UTC."
format: "date-time"
type: "string"
activationDateTime:
description: "Дата и время конвертации стоп-заявки в биржевую по UTC."
format: "date-time"
type: "string"
expirationTime:
description: "Дата и время снятия заявки по UTC."
format: "date-time"
type: "string"
price:
$ref: "#/components/schemas/v1MoneyValue"
stopPrice:
$ref: "#/components/schemas/v1MoneyValue"
instrumentUid:
description: "`instrument_uid`-идентификатор инструмента."
type: "string"
takeProfitType:
$ref: "#/components/schemas/v1TakeProfitType"
trailingData:
$ref: "#/components/schemas/v1StopOrderTrailingData"
status:
$ref: "#/components/schemas/v1StopOrderStatusOption"
exchangeOrderType:
$ref: "#/components/schemas/v1ExchangeOrderType"
exchangeOrderId:
description: "Идентификатор биржевой заявки."
type: "string"
type: "object"
v1StopOrderDirection:
default: "STOP_ORDER_DIRECTION_UNSPECIFIED"
description: "Направление сделки стоп-заявки.\n\n - STOP_ORDER_DIRECTION_UNSPECIFIED: Значение не указано.\n - STOP_ORDER_DIRECTION_BUY: Покупка.\n - STOP_ORDER_DIRECTION_SELL: Продажа."
enum:
- "STOP_ORDER_DIRECTION_UNSPECIFIED"
- "STOP_ORDER_DIRECTION_BUY"
- "STOP_ORDER_DIRECTION_SELL"
type: "string"
v1StopOrderExpirationType:
default: "STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"
description: "Тип экспирации стоп-заявке.\n\n - STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED: Значение не указано.\n - STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL: Действительно до отмены.\n - STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE: Действительно до даты снятия."
enum:
- "STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"
- "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL"
- "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE"
type: "string"
v1StopOrderStatusOption:
default: "STOP_ORDER_STATUS_UNSPECIFIED"
description: "Статус стоп-заяки.\n\n - STOP_ORDER_STATUS_UNSPECIFIED: Значение не указано.\n - STOP_ORDER_STATUS_ALL: Все заявки.\n - STOP_ORDER_STATUS_ACTIVE: Активные заявки.\n - STOP_ORDER_STATUS_EXECUTED: Исполненные заявки.\n - STOP_ORDER_STATUS_CANCELED: Отмененные заявки.\n - STOP_ORDER_STATUS_EXPIRED: Истекшие заявки."
enum:
- "STOP_ORDER_STATUS_UNSPECIFIED"
- "STOP_ORDER_STATUS_ALL"
- "STOP_ORDER_STATUS_ACTIVE"
- "STOP_ORDER_STATUS_EXECUTED"
- "STOP_ORDER_STATUS_CANCELED"
- "STOP_ORDER_STATUS_EXPIRED"
type: "string"
v1StopOrderTrailingData:
example:
indent:
nano: 6
units: "units"
price:
nano: 6
units: "units"
extr:
nano: 6
units: "units"
spread:
nano: 6
units: "units"
properties:
indent:
$ref: "#/components/schemas/v1Quotation"
indentType:
$ref: "#/components/schemas/v1TrailingValueType"
spread:
$ref: "#/components/schemas/v1Quotation"
spreadType:
$ref: "#/components/schemas/v1TrailingValueType"
status:
$ref: "#/components/schemas/v1TrailingStopStatus"
price:
$ref: "#/components/schemas/v1Quotation"
extr:
$ref: "#/components/schemas/v1Quotation"
type: "object"
v1StopOrderType:
default: "STOP_ORDER_TYPE_UNSPECIFIED"
description: "Тип стоп-заявки.\n\n - STOP_ORDER_TYPE_UNSPECIFIED: Значение не указано.\n - STOP_ORDER_TYPE_TAKE_PROFIT: `Take-profit`-заявка.\n - STOP_ORDER_TYPE_STOP_LOSS: `Stop-loss`-заявка.\n - STOP_ORDER_TYPE_STOP_LIMIT: `Stop-limit`-заявка."
enum:
- "STOP_ORDER_TYPE_UNSPECIFIED"
- "STOP_ORDER_TYPE_TAKE_PROFIT"
- "STOP_ORDER_TYPE_STOP_LOSS"
- "STOP_ORDER_TYPE_STOP_LIMIT"
type: "string"
v1Strategy:
example:
strategyName: "strategyName"
strategyDescription: "strategyDescription"
averageSignalYield:
nano: 6
units: "units"
strategyUrl: "strategyUrl"
yieldYear:
nano: 6
units: "units"
yield:
nano: 6
units: "units"
strategyId: "strategyId"
totalSignals: 6
timeInPosition: "timeInPosition"
averageSignalYieldYear:
nano: 6
units: "units"
activeSignals: 0
properties:
strategyId:
description: "Идентификатор стратегии."
type: "string"
strategyName:
description: "Название стратегии."
type: "string"
strategyDescription:
description: "Описание стратегии."
type: "string"
strategyUrl:
description: "Ссылка на страницу с описанием стратегии."
type: "string"
strategyType:
$ref: "#/components/schemas/v1StrategyType"
activeSignals:
description: "Количество активных сигналов."
format: "int32"
type: "integer"
totalSignals:
description: "Общее количество сигналов."
format: "int32"
type: "integer"
timeInPosition:
description: "Среднее время нахождения сигнала в позиции."
format: "int64"
type: "string"
averageSignalYield:
$ref: "#/components/schemas/v1Quotation"
averageSignalYieldYear:
$ref: "#/components/schemas/v1Quotation"
yield:
$ref: "#/components/schemas/v1Quotation"
yieldYear:
$ref: "#/components/schemas/v1Quotation"
required:
- "activeSignals"
- "averageSignalYield"
- "averageSignalYieldYear"
- "strategyId"
- "strategyName"
- "strategyType"
- "timeInPosition"
- "totalSignals"
- "yield"
- "yieldYear"
title: "Стратегия"
type: "object"
v1StrategyType:
default: "STRATEGY_TYPE_UNSPECIFIED"
description: "Тип стратегии.\n\n - STRATEGY_TYPE_UNSPECIFIED: Не определен.\n - STRATEGY_TYPE_TECHNICAL: Техническая стратегия.\n - STRATEGY_TYPE_FUNDAMENTAL: Фундаментальная стратегия."
enum:
- "STRATEGY_TYPE_UNSPECIFIED"
- "STRATEGY_TYPE_TECHNICAL"
- "STRATEGY_TYPE_FUNDAMENTAL"
type: "string"
v1StreamLimit:
description: "Лимит stream-соединений."
example:
streams:
- "streams"
- "streams"
limit: 6
open: 1
properties:
limit:
description: "Максимальное количество stream-соединений."
format: "int32"
type: "integer"
streams:
description: "Названия stream-методов."
items:
type: "string"
type: "array"
open:
description: "Текущее количество открытых stream-соединений."
format: "int32"
type: "integer"
type: "object"
v1StructuredProductType:
default: "SP_TYPE_UNSPECIFIED"
description: "Тип структурной ноты.\n\n - SP_TYPE_UNSPECIFIED: Тип не определен.\n - SP_TYPE_DELIVERABLE: Поставочный.\n - SP_TYPE_NON_DELIVERABLE: Беспоставочный."
enum:
- "SP_TYPE_UNSPECIFIED"
- "SP_TYPE_DELIVERABLE"
- "SP_TYPE_NON_DELIVERABLE"
type: "string"
v1SubscribeCandlesRequest:
description: "subscribeCandles | Изменения статуса подписки на свечи."
properties:
subscriptionAction:
$ref: "#/components/schemas/v1SubscriptionAction"
instruments:
description: "Массив инструментов для подписки на свечи."
items:
$ref: "#/components/schemas/v1CandleInstrument"
type: "array"
waitingClose:
description: "Флаг ожидания закрытия временного интервала для отправки свечи."
type: "boolean"
candleSourceType:
$ref: "#/components/schemas/v1GetCandlesRequestCandleSource"
type: "object"
v1SubscribeCandlesResponse:
description: "Результат изменения статус подписки на свечи."
example:
candlesSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id)."
type: "string"
candlesSubscriptions:
description: "Массив статусов подписки на свечи."
items:
$ref: "#/components/schemas/v1CandleSubscription"
type: "array"
type: "object"
v1SubscribeInfoRequest:
description: "Изменение статуса подписки на торговый статус инструмента."
properties:
subscriptionAction:
$ref: "#/components/schemas/v1SubscriptionAction"
instruments:
description: "Массив инструментов для подписки на торговый статус."
items:
$ref: "#/components/schemas/v1InfoInstrument"
type: "array"
type: "object"
v1SubscribeInfoResponse:
description: "Результат изменения статуса подписки на торговый статус."
example:
infoSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id)."
type: "string"
infoSubscriptions:
description: "Массив статусов подписки на торговый статус."
items:
$ref: "#/components/schemas/v1InfoSubscription"
type: "array"
type: "object"
v1SubscribeLastPriceRequest:
description: "Изменение статуса подписки на цену последней сделки по инструменту."
properties:
subscriptionAction:
$ref: "#/components/schemas/v1SubscriptionAction"
instruments:
description: "Массив инструментов для подписки на цену последней сделки."
items:
$ref: "#/components/schemas/v1LastPriceInstrument"
type: "array"
type: "object"
v1SubscribeLastPriceResponse:
description: "Результат изменения статуса подписки на цену последней сделки."
example:
lastPriceSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id)."
type: "string"
lastPriceSubscriptions:
description: "Массив статусов подписки на цену последней сделки."
items:
$ref: "#/components/schemas/v1LastPriceSubscription"
type: "array"
type: "object"
v1SubscribeOrderBookRequest:
description: "Запрос на изменение статуса подписки на стаканы."
properties:
subscriptionAction:
$ref: "#/components/schemas/v1SubscriptionAction"
instruments:
description: "Массив инструментов для подписки на стаканы."
items:
$ref: "#/components/schemas/v1OrderBookInstrument"
type: "array"
type: "object"
v1SubscribeOrderBookResponse:
description: "Результат изменения статуса подписки на стаканы."
example:
orderBookSubscriptions:
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id)."
type: "string"
orderBookSubscriptions:
description: "Массив статусов подписки на стаканы."
items:
$ref: "#/components/schemas/v1OrderBookSubscription"
type: "array"
type: "object"
v1SubscribeTradesRequest:
description: "Изменение статуса подписки на поток обезличенных сделок."
properties:
subscriptionAction:
$ref: "#/components/schemas/v1SubscriptionAction"
instruments:
description: "Массив инструментов для подписки на поток обезличенных сделок."
items:
$ref: "#/components/schemas/v1TradeInstrument"
type: "array"
tradeSource:
$ref: "#/components/schemas/v1TradeSourceType"
type: "object"
v1SubscribeTradesResponse:
description: "Результат изменения статуса подписки на поток обезличенных сделок."
example:
tradeSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса. [Подробнее](./grpc#tracking-id)."
type: "string"
tradeSubscriptions:
description: "Массив статусов подписки на поток сделок."
items:
$ref: "#/components/schemas/v1TradeSubscription"
type: "array"
tradeSource:
$ref: "#/components/schemas/v1TradeSourceType"
type: "object"
v1SubscriptionAction:
default: "SUBSCRIPTION_ACTION_UNSPECIFIED"
description: "Тип операции со списком подписок.\n\n - SUBSCRIPTION_ACTION_UNSPECIFIED: Статус подписки не определен.\n - SUBSCRIPTION_ACTION_SUBSCRIBE: Подписаться.\n - SUBSCRIPTION_ACTION_UNSUBSCRIBE: Отписаться."
enum:
- "SUBSCRIPTION_ACTION_UNSPECIFIED"
- "SUBSCRIPTION_ACTION_SUBSCRIBE"
- "SUBSCRIPTION_ACTION_UNSUBSCRIBE"
type: "string"
v1SubscriptionInterval:
default: "SUBSCRIPTION_INTERVAL_UNSPECIFIED"
description: "Интервал свечи.\n\n - SUBSCRIPTION_INTERVAL_UNSPECIFIED: Интервал свечи не определен.\n - SUBSCRIPTION_INTERVAL_ONE_MINUTE: Минутные свечи.\n - SUBSCRIPTION_INTERVAL_FIVE_MINUTES: Пятиминутные свечи.\n - SUBSCRIPTION_INTERVAL_FIFTEEN_MINUTES: Пятнадцатиминутные свечи.\n - SUBSCRIPTION_INTERVAL_ONE_HOUR: Часовые свечи.\n - SUBSCRIPTION_INTERVAL_ONE_DAY: Дневные свечи.\n - SUBSCRIPTION_INTERVAL_2_MIN: Двухминутные свечи.\n - SUBSCRIPTION_INTERVAL_3_MIN: Трехминутные свечи.\n - SUBSCRIPTION_INTERVAL_10_MIN: Десятиминутные свечи.\n - SUBSCRIPTION_INTERVAL_30_MIN: Тридцатиминутные свечи.\n - SUBSCRIPTION_INTERVAL_2_HOUR: Двухчасовые свечи.\n - SUBSCRIPTION_INTERVAL_4_HOUR: Четырехчасовые свечи.\n - SUBSCRIPTION_INTERVAL_WEEK: Недельные свечи.\n - SUBSCRIPTION_INTERVAL_MONTH: Месячные свечи."
enum:
- "SUBSCRIPTION_INTERVAL_UNSPECIFIED"
- "SUBSCRIPTION_INTERVAL_ONE_MINUTE"
- "SUBSCRIPTION_INTERVAL_FIVE_MINUTES"
- "SUBSCRIPTION_INTERVAL_FIFTEEN_MINUTES"
- "SUBSCRIPTION_INTERVAL_ONE_HOUR"
- "SUBSCRIPTION_INTERVAL_ONE_DAY"
- "SUBSCRIPTION_INTERVAL_2_MIN"
- "SUBSCRIPTION_INTERVAL_3_MIN"
- "SUBSCRIPTION_INTERVAL_10_MIN"
- "SUBSCRIPTION_INTERVAL_30_MIN"
- "SUBSCRIPTION_INTERVAL_2_HOUR"
- "SUBSCRIPTION_INTERVAL_4_HOUR"
- "SUBSCRIPTION_INTERVAL_WEEK"
- "SUBSCRIPTION_INTERVAL_MONTH"
type: "string"
v1SubscriptionResponse:
example:
streamId: "streamId"
accounts:
- "accounts"
- "accounts"
error:
code: "code"
message: "message"
trackingId: "trackingId"
properties:
trackingId:
description: "Уникальный идентификатор запроса, подробнее: [tracking_id](./grpc#tracking-id)."
type: "string"
status:
$ref: "#/components/schemas/v1ResultSubscriptionStatus"
streamId:
title: "Идентификатор открытого соединения"
type: "string"
accounts:
description: "Идентификаторы счетов."
items:
type: "string"
type: "array"
error:
$ref: "#/components/schemas/v1ErrorDetail"
title: "Информация по подпискам"
type: "object"
v1SubscriptionStatus:
default: "SUBSCRIPTION_STATUS_UNSPECIFIED"
description: "Результат подписки.\n\n - SUBSCRIPTION_STATUS_UNSPECIFIED: Статус подписки не определен.\n - SUBSCRIPTION_STATUS_SUCCESS: Успешно.\n - SUBSCRIPTION_STATUS_INSTRUMENT_NOT_FOUND: Инструмент не найден.\n - SUBSCRIPTION_STATUS_SUBSCRIPTION_ACTION_IS_INVALID: Некорректный статус подписки. [Список возможных значений](./marketdata#subscriptionaction).\n - SUBSCRIPTION_STATUS_DEPTH_IS_INVALID: Некорректная глубина стакана. Доступные значения — 1, 10, 20, 30, 40, 50.\n - SUBSCRIPTION_STATUS_INTERVAL_IS_INVALID: Некорректный интервал свечей. [Список возможных значений](./marketdata#subscriptioninterval).\n - SUBSCRIPTION_STATUS_LIMIT_IS_EXCEEDED: Превышен лимит на общее количество подписок в рамках стрима. [Лимитная политика](./limits/).\n - SUBSCRIPTION_STATUS_INTERNAL_ERROR: Внутренняя ошибка сервиса.\n - SUBSCRIPTION_STATUS_TOO_MANY_REQUESTS: Превышен лимит на количество запросов на подписки в течение установленного отрезка времени.\n - SUBSCRIPTION_STATUS_SUBSCRIPTION_NOT_FOUND: Активная подписка не найдена. Ошибка может возникнуть только при отписке от несуществующей подписки.\n - SUBSCRIPTION_STATUS_SOURCE_IS_INVALID: Указан некорректный источник."
enum:
- "SUBSCRIPTION_STATUS_UNSPECIFIED"
- "SUBSCRIPTION_STATUS_SUCCESS"
- "SUBSCRIPTION_STATUS_INSTRUMENT_NOT_FOUND"
- "SUBSCRIPTION_STATUS_SUBSCRIPTION_ACTION_IS_INVALID"
- "SUBSCRIPTION_STATUS_DEPTH_IS_INVALID"
- "SUBSCRIPTION_STATUS_INTERVAL_IS_INVALID"
- "SUBSCRIPTION_STATUS_LIMIT_IS_EXCEEDED"
- "SUBSCRIPTION_STATUS_INTERNAL_ERROR"
- "SUBSCRIPTION_STATUS_TOO_MANY_REQUESTS"
- "SUBSCRIPTION_STATUS_SUBSCRIPTION_NOT_FOUND"
- "SUBSCRIPTION_STATUS_SOURCE_IS_INVALID"
type: "string"
v1TakeProfitType:
default: "TAKE_PROFIT_TYPE_UNSPECIFIED"
description: "Тип TakeProfit-заявки.\n\n - TAKE_PROFIT_TYPE_UNSPECIFIED: Значение не указано.\n - TAKE_PROFIT_TYPE_REGULAR: Обычная заявка, значение по умолчанию.\n - TAKE_PROFIT_TYPE_TRAILING: Трейлинг-стоп."
enum:
- "TAKE_PROFIT_TYPE_UNSPECIFIED"
- "TAKE_PROFIT_TYPE_REGULAR"
- "TAKE_PROFIT_TYPE_TRAILING"
type: "string"
v1TimeInForceType:
default: "TIME_IN_FORCE_UNSPECIFIED"
description: "- TIME_IN_FORCE_UNSPECIFIED: Значение не определено см. TIME_IN_FORCE_DAY\n - TIME_IN_FORCE_DAY: Заявка действует до конца торгового дня. Значение по умолчанию\n - TIME_IN_FORCE_FILL_AND_KILL: Если в момент выставления возможно исполнение заявки(в т.ч. частичное), заявка будет исполнена или отменена сразу после выставления\n - TIME_IN_FORCE_FILL_OR_KILL: Если в момент выставления возможно полное исполнение заявки, заявка будет исполнена или отменена сразу после выставления, недоступно для срочного рынка и торговли по выходным"
enum:
- "TIME_IN_FORCE_UNSPECIFIED"
- "TIME_IN_FORCE_DAY"
- "TIME_IN_FORCE_FILL_AND_KILL"
- "TIME_IN_FORCE_FILL_OR_KILL"
title: "Алгоритм исполнения заявки"
type: "string"
v1Trade:
description: "Информация о сделке."
example:
quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
direction:
$ref: "#/components/schemas/v1TradeDirection"
price:
$ref: "#/components/schemas/v1Quotation"
quantity:
description: "Количество лотов."
format: "int64"
type: "string"
time:
description: "Время сделки в часовом поясе UTC по времени биржи."
format: "date-time"
type: "string"
instrumentUid:
description: "UID инструмента."
type: "string"
tradeSource:
$ref: "#/components/schemas/v1TradeSourceType"
type: "object"
v1TradeDirection:
default: "TRADE_DIRECTION_UNSPECIFIED"
description: "Направление сделки.\n\n - TRADE_DIRECTION_UNSPECIFIED: Направление сделки не определено.\n - TRADE_DIRECTION_BUY: Покупка.\n - TRADE_DIRECTION_SELL: Продажа."
enum:
- "TRADE_DIRECTION_UNSPECIFIED"
- "TRADE_DIRECTION_BUY"
- "TRADE_DIRECTION_SELL"
type: "string"
v1TradeInstrument:
description: "Запрос подписки на поток обезличенных сделок."
properties:
figi:
description: "Deprecated FIGI-идентификатор инструмента. Используйте instrument_id`."
type: "string"
deprecated: true
instrumentId:
description: "Идентификатор инструмента. Принимает значение `figi` или `instrument_uid`."
type: "string"
type: "object"
v1TradeSourceType:
default: "TRADE_SOURCE_UNSPECIFIED"
description: "Типы источников сделок.\n\n - TRADE_SOURCE_UNSPECIFIED: Тип источника сделки не определён.\n - TRADE_SOURCE_EXCHANGE: Биржевые сделки.\n - TRADE_SOURCE_DEALER: Сделки дилера.\n - TRADE_SOURCE_ALL: Все сделки."
enum:
- "TRADE_SOURCE_UNSPECIFIED"
- "TRADE_SOURCE_EXCHANGE"
- "TRADE_SOURCE_DEALER"
- "TRADE_SOURCE_ALL"
type: "string"
v1TradeSubscription:
description: "Статус подписки."
example:
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
subscriptionStatus:
$ref: "#/components/schemas/v1SubscriptionStatus"
instrumentUid:
description: "UID инструмента."
type: "string"
streamId:
description: "Идентификатор открытого соединения."
type: "string"
subscriptionId:
description: "Идентификатор подписки в формате UUID."
type: "string"
type: "object"
v1TradesStreamRequest:
description: "Запрос установки соединения."
properties:
accounts:
description: "Идентификаторы счетов."
items:
type: "string"
type: "array"
pingDelayMs:
description: "Задержка (пинг) сообщений: 5000–180 000 миллисекунд. Значение по умолчанию — 120 000."
format: "int32"
type: "integer"
type: "object"
v1TradesStreamResponse:
description: "Информация о торговых поручениях."
example:
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
subscription:
streamId: "streamId"
accounts:
- "accounts"
- "accounts"
error:
code: "code"
message: "message"
trackingId: "trackingId"
orderTrades:
createdAt: 2000-01-23T04:56:07.000Z
accountId: "accountId"
orderId: "orderId"
instrumentUid: "instrumentUid"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
figi: "figi"
properties:
orderTrades:
$ref: "#/components/schemas/v1OrderTrades"
ping:
$ref: "#/components/schemas/v1Ping"
subscription:
$ref: "#/components/schemas/v1SubscriptionResponse"
type: "object"
v1TradingDay:
description: "Информация о времени торгов."
example:
date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
properties:
date:
description: "Дата."
format: "date-time"
type: "string"
isTradingDay:
description: "Признак торгового дня на бирже."
type: "boolean"
startTime:
description: "Время начала торгов по UTC."
format: "date-time"
type: "string"
endTime:
description: "Время окончания торгов по UTC."
format: "date-time"
type: "string"
openingAuctionStartTime:
description: "Время начала аукциона открытия по UTC."
format: "date-time"
type: "string"
closingAuctionEndTime:
description: "Время окончания аукциона закрытия по UTC."
format: "date-time"
type: "string"
eveningOpeningAuctionStartTime:
description: "Время начала аукциона открытия вечерней сессии по UTC."
format: "date-time"
type: "string"
eveningStartTime:
description: "Время начала вечерней сессии по UTC."
format: "date-time"
type: "string"
eveningEndTime:
description: "Время окончания вечерней сессии по UTC."
format: "date-time"
type: "string"
clearingStartTime:
description: "Время начала основного клиринга по UTC."
format: "date-time"
type: "string"
clearingEndTime:
description: "Время окончания основного клиринга по UTC."
format: "date-time"
type: "string"
premarketStartTime:
description: "Время начала премаркета по UTC."
format: "date-time"
type: "string"
premarketEndTime:
description: "Время окончания премаркета по UTC."
format: "date-time"
type: "string"
closingAuctionStartTime:
description: "Время начала аукциона закрытия по UTC."
format: "date-time"
type: "string"
openingAuctionEndTime:
description: "Время окончания аукциона открытия по UTC."
format: "date-time"
type: "string"
intervals:
description: "Торговые интервалы."
items:
$ref: "#/components/schemas/v1TradingInterval"
type: "array"
type: "object"
v1TradingInterval:
example:
interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
properties:
type:
description: "Название интервала."
type: "string"
interval:
$ref: "#/components/schemas/TradingIntervalTimeInterval"
type: "object"
v1TradingSchedule:
description: "Данные по торговой площадке."
example:
days:
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
exchange: "exchange"
properties:
exchange:
description: "Наименование торговой площадки."
type: "string"
days:
description: "Массив с торговыми и неторговыми днями."
items:
$ref: "#/components/schemas/v1TradingDay"
type: "array"
type: "object"
v1TradingSchedulesRequest:
description: "Запрос расписания торгов."
properties:
exchange:
description: "Наименование биржи или расчетного календаря. <br/>Если не передается, возвращается информация по всем доступным торговым площадкам."
type: "string"
from:
description: "Начало периода по UTC."
format: "date-time"
type: "string"
to:
description: "Окончание периода по UTC."
format: "date-time"
type: "string"
type: "object"
v1TradingSchedulesResponse:
description: "Список торговых площадок."
example:
exchanges:
- days:
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
exchange: "exchange"
- days:
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
- date: 2000-01-23T04:56:07.000Z
clearingEndTime: 2000-01-23T04:56:07.000Z
openingAuctionStartTime: 2000-01-23T04:56:07.000Z
closingAuctionEndTime: 2000-01-23T04:56:07.000Z
eveningEndTime: 2000-01-23T04:56:07.000Z
premarketStartTime: 2000-01-23T04:56:07.000Z
eveningOpeningAuctionStartTime: 2000-01-23T04:56:07.000Z
isTradingDay: true
intervals:
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
- interval:
endTs: 2000-01-23T04:56:07.000Z
startTs: 2000-01-23T04:56:07.000Z
type: "type"
eveningStartTime: 2000-01-23T04:56:07.000Z
openingAuctionEndTime: 2000-01-23T04:56:07.000Z
premarketEndTime: 2000-01-23T04:56:07.000Z
closingAuctionStartTime: 2000-01-23T04:56:07.000Z
clearingStartTime: 2000-01-23T04:56:07.000Z
startTime: 2000-01-23T04:56:07.000Z
endTime: 2000-01-23T04:56:07.000Z
exchange: "exchange"
properties:
exchanges:
description: "Список торговых площадок и режимов торгов."
items:
$ref: "#/components/schemas/v1TradingSchedule"
type: "array"
type: "object"
v1TradingStatus:
description: "Пакет изменения торгового статуса."
example:
limitOrderAvailableFlag: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
properties:
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
tradingStatus:
$ref: "#/components/schemas/v1SecurityTradingStatus"
time:
description: "Время изменения торгового статуса по UTC."
format: "date-time"
type: "string"
limitOrderAvailableFlag:
description: "Признак доступности выставления лимитной заявки по инструменту."
type: "boolean"
marketOrderAvailableFlag:
description: "Признак доступности выставления рыночной заявки по инструменту."
type: "boolean"
instrumentUid:
description: "UID инструмента."
type: "string"
type: "object"
v1TrailingStopStatus:
default: "TRAILING_STOP_UNSPECIFIED"
description: "Статус трейлинг-стопа.\n\n - TRAILING_STOP_UNSPECIFIED: Значение не указано.\n - TRAILING_STOP_ACTIVE: Активный.\n - TRAILING_STOP_ACTIVATED: Активированный."
enum:
- "TRAILING_STOP_UNSPECIFIED"
- "TRAILING_STOP_ACTIVE"
- "TRAILING_STOP_ACTIVATED"
type: "string"
v1TrailingValueType:
default: "TRAILING_VALUE_UNSPECIFIED"
description: "Тип параметров значений трейлинг-стопа.\n\n - TRAILING_VALUE_UNSPECIFIED: Значение не указано.\n - TRAILING_VALUE_ABSOLUTE: Абсолютное значение в единицах цены.\n - TRAILING_VALUE_RELATIVE: Относительное значение в процентах."
enum:
- "TRAILING_VALUE_UNSPECIFIED"
- "TRAILING_VALUE_ABSOLUTE"
- "TRAILING_VALUE_RELATIVE"
type: "string"
v1UnaryLimit:
description: "Лимит unary-методов."
example:
limitPerMinute: 0
methods:
- "methods"
- "methods"
properties:
limitPerMinute:
description: "Количество unary-запросов в минуту."
format: "int32"
type: "integer"
methods:
description: "Названия методов."
items:
type: "string"
type: "array"
type: "object"
v1VirtualPortfolioPosition:
example:
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
properties:
positionUid:
description: "Уникальный идентификатор позиции."
type: "string"
instrumentUid:
description: "Уникальный идентификатор инструмента."
type: "string"
figi:
description: "FIGI-идентификатор инструмента."
type: "string"
instrumentType:
description: "Тип инструмента."
type: "string"
quantity:
$ref: "#/components/schemas/v1Quotation"
averagePositionPrice:
$ref: "#/components/schemas/v1MoneyValue"
expectedYield:
$ref: "#/components/schemas/v1Quotation"
expectedYieldFifo:
$ref: "#/components/schemas/v1Quotation"
expireDate:
description: "Дата, до которой нужно продать виртуальные бумаги. После этой даты виртуальная позиция «сгораетт»."
format: "date-time"
type: "string"
currentPrice:
$ref: "#/components/schemas/v1MoneyValue"
averagePositionPriceFifo:
$ref: "#/components/schemas/v1MoneyValue"
dailyYield:
$ref: "#/components/schemas/v1MoneyValue"
type: "object"
v1WithdrawLimitsRequest:
description: "Запрос доступного остатка для вывода."
properties:
accountId:
description: "Идентификатор счета пользователя."
type: "string"
required:
- "accountId"
type: "object"
v1WithdrawLimitsResponse:
description: "Доступный остаток для вывода."
example:
blockedGuarantee:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
money:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
blocked:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
properties:
money:
description: "Массив валютных позиций портфеля."
items:
$ref: "#/components/schemas/v1MoneyValue"
type: "array"
blocked:
description: "Массив заблокированных валютных позиций портфеля."
items:
$ref: "#/components/schemas/v1MoneyValue"
type: "array"
blockedGuarantee:
description: "Заблокировано под гарантийное обеспечение фьючерсов."
items:
$ref: "#/components/schemas/v1MoneyValue"
type: "array"
type: "object"
Stream_result_of_v1MarketDataResponse:
example:
result:
subscribeInfoResponse:
infoSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
trade:
quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
subscribeOrderBookResponse:
orderBookSubscriptions:
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- depth: 0
streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
candle:
volume: "volume"
high:
nano: 6
units: "units"
lastTradeTs: 2000-01-23T04:56:07.000Z
low:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
close:
nano: 6
units: "units"
open:
nano: 6
units: "units"
orderbook:
depth: 6
asks:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
bids:
- quantity: "quantity"
price:
nano: 6
units: "units"
- quantity: "quantity"
price:
nano: 6
units: "units"
limitUp:
nano: 6
units: "units"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
limitDown:
nano: 6
units: "units"
isConsistent: true
subscribeTradesResponse:
tradeSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
tradingStatus:
limitOrderAvailableFlag: true
marketOrderAvailableFlag: true
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
subscribeCandlesResponse:
candlesSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
waitingClose: true
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
subscribeLastPriceResponse:
lastPriceSubscriptions:
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
- streamId: "streamId"
instrumentUid: "instrumentUid"
figi: "figi"
subscriptionId: "subscriptionId"
trackingId: "trackingId"
lastPrice:
price:
nano: 6
units: "units"
instrumentUid: "instrumentUid"
figi: "figi"
time: 2000-01-23T04:56:07.000Z
error:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
result:
$ref: "#/components/schemas/v1MarketDataResponse"
error:
$ref: "#/components/schemas/rpcStatus"
title: "Stream result of v1MarketDataResponse"
type: "object"
Stream_result_of_v1PortfolioStreamResponse:
example:
result:
subscriptions:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
portfolio:
totalAmountBonds:
nano: 5
currency: "currency"
units: "units"
totalAmountFutures:
nano: 5
currency: "currency"
units: "units"
totalAmountSp:
nano: 5
currency: "currency"
units: "units"
positions:
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
- varMargin:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
averagePositionPricePt:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
currentPrice:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
figi: "figi"
quantityLots:
nano: 6
units: "units"
blockedLots:
nano: 6
units: "units"
averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
blocked: true
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
currentNkd:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountEtf:
nano: 5
currency: "currency"
units: "units"
accountId: "accountId"
totalAmountCurrencies:
nano: 5
currency: "currency"
units: "units"
dailyYield:
nano: 5
currency: "currency"
units: "units"
expectedYield:
nano: 6
units: "units"
totalAmountShares:
nano: 5
currency: "currency"
units: "units"
totalAmountPortfolio:
nano: 5
currency: "currency"
units: "units"
virtualPositions:
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
- averagePositionPrice:
nano: 5
currency: "currency"
units: "units"
instrumentType: "instrumentType"
quantity:
nano: 6
units: "units"
expectedYieldFifo:
nano: 6
units: "units"
averagePositionPriceFifo:
nano: 5
currency: "currency"
units: "units"
instrumentUid: "instrumentUid"
dailyYield:
nano: 5
currency: "currency"
units: "units"
positionUid: "positionUid"
currentPrice:
nano: 5
currency: "currency"
units: "units"
figi: "figi"
expectedYield:
nano: 6
units: "units"
expireDate: 2000-01-23T04:56:07.000Z
dailyYieldRelative:
nano: 6
units: "units"
totalAmountOptions:
nano: 5
currency: "currency"
units: "units"
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
error:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
result:
$ref: "#/components/schemas/v1PortfolioStreamResponse"
error:
$ref: "#/components/schemas/rpcStatus"
title: "Stream result of v1PortfolioStreamResponse"
type: "object"
Stream_result_of_v1PositionsStreamResponse:
example:
result:
subscriptions:
streamId: "streamId"
accounts:
- accountId: "accountId"
- accountId: "accountId"
trackingId: "trackingId"
initialPositions:
limitsLoadingInProgress: true
accountId: "accountId"
money:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
blocked:
- nano: 5
currency: "currency"
units: "units"
- nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
position:
date: 2000-01-23T04:56:07.000Z
accountId: "accountId"
money:
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
- availableValue:
nano: 5
currency: "currency"
units: "units"
blockedValue:
nano: 5
currency: "currency"
units: "units"
options:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
futures:
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
- blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
securities:
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
- instrumentType: "instrumentType"
blocked: "blocked"
balance: "balance"
instrumentUid: "instrumentUid"
positionUid: "positionUid"
figi: "figi"
exchangeBlocked: true
error:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
result:
$ref: "#/components/schemas/v1PositionsStreamResponse"
error:
$ref: "#/components/schemas/rpcStatus"
title: "Stream result of v1PositionsStreamResponse"
type: "object"
Stream_result_of_v1OrderStateStreamResponse:
example:
result:
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
subscription:
streamId: "streamId"
accounts:
- "accounts"
- "accounts"
error:
code: "code"
message: "message"
trackingId: "trackingId"
orderState:
orderId: "orderId"
initialOrderPrice:
nano: 5
currency: "currency"
units: "units"
createdAt: 2000-01-23T04:56:07.000Z
completionTime: 2000-01-23T04:56:07.000Z
lotsLeft: "lotsLeft"
orderPrice:
nano: 5
currency: "currency"
units: "units"
executedOrderPrice:
nano: 5
currency: "currency"
units: "units"
currency: "currency"
classCode: "classCode"
ticker: "ticker"
amount:
nano: 5
currency: "currency"
units: "units"
lotSize: 0
lotsCancelled: "lotsCancelled"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
accountId: "accountId"
lotsExecuted: "lotsExecuted"
clientCode: "clientCode"
lotsRequested: "lotsRequested"
instrumentUid: "instrumentUid"
orderRequestId: "orderRequestId"
exchange: "exchange"
error:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
result:
$ref: "#/components/schemas/v1OrderStateStreamResponse"
error:
$ref: "#/components/schemas/rpcStatus"
title: "Stream result of v1OrderStateStreamResponse"
type: "object"
Stream_result_of_v1TradesStreamResponse:
example:
result:
ping:
streamId: "streamId"
pingRequestTime: 2000-01-23T04:56:07.000Z
time: 2000-01-23T04:56:07.000Z
subscription:
streamId: "streamId"
accounts:
- "accounts"
- "accounts"
error:
code: "code"
message: "message"
trackingId: "trackingId"
orderTrades:
createdAt: 2000-01-23T04:56:07.000Z
accountId: "accountId"
orderId: "orderId"
instrumentUid: "instrumentUid"
trades:
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
- dateTime: 2000-01-23T04:56:07.000Z
quantity: "quantity"
price:
nano: 6
units: "units"
tradeId: "tradeId"
figi: "figi"
error:
code: 1
details:
- "@type": "@type"
- "@type": "@type"
message: "message"
properties:
result:
$ref: "#/components/schemas/v1TradesStreamResponse"
error:
$ref: "#/components/schemas/rpcStatus"
title: "Stream result of v1TradesStreamResponse"
type: "object"
ErrorResponse:
description: "Данные об ошибке"
type: "object"
required:
- "code"
- "message"
- "description"
properties:
code:
description: "Уникальный идентификатор ошибки"
type: "integer"
example: 3
message:
description: "Пользовательское сообщение об ошибке"
type: "string"
example: "interval is invalid"
description:
description: "Код ошибки"
type: "integer"
example: 30011
securitySchemes:
Bearer:
type: "http"
scheme: "bearer"