Сводная информация о портфеле
Запрос нельзя выполнить анонимно. Обязательный параметр token
должен содержать актуальный Access Токен.
Для этой операции есть альтернативный HTTP-запрос.
Запрос создаёт подписку на получение сводной информации об указанном портфеле.
Запрос
Для создания подписки на информационный канал отправьте в установленное WebSocket-соединение сообщение с телом запроса, содержащим детали создаваемой подписки.
- Тело запроса
- Схема
{
"opcode": "SummariesGetAndSubscribeV2",
"portfolio": "D39004",
"skipHistory": false,
"exchange": "MOEX",
"format": "Simple",
"frequency": 100,
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"token": "eyJhbGciOiJ..."
}
Параметры тела запроса
OrderBookGetAndSubscribe
— Подписка на биржевой стаканBarsGetAndSubscribe
— Подписка на историю цен (свечи)QuotesSubscribe
— Подписка на информацию о котировкахInstrumentsGetAndSubscribeV2
— Подписка на изменение информации о финансовых инструментах на выбранной биржеAllTradesGetAndSubscribe
— Подписка на все сделкиPositionsGetAndSubscribeV2
— Подписка на информацию о текущих позициях по торговым инструментам и деньгамSummariesGetAndSubscribeV2
— Подписка на сводную информацию по портфелюRisksGetAndSubscribe
— Подписка на сводную информацию по портфельным рискамSpectraRisksGetAndSubscribe
— Подписка на информацию по рискам срочного рынка (FORTS)TradesGetAndSubscribeV2
— Подписка на информацию о сделкахOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаStopOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаUnsubscribe
— Отмена существующей подпискиtrue
— отображать только новые данныеfalse
— отображать в том числе данные из историиMOEX
— Московская БиржаSPBX
— СПБ БиржаSimple
— оригинальный формат данных. Поддерживает устаревшие параметры для обеспечения обратной совместимостиSlim
— облегчённый формат данных для быстрой передачи сообщений. Не поддерживает устаревшие параметрыHeavy
— полный формат данных, развивающийся и дополняющийся новыми полями. Не поддерживает устаревшие параметрыSimple
— 25 миллисекундSlim
— 10 миллисекундHeavy
— 500 миллисекунд
Пример: SummariesGetAndSubscribeV2
Код выполняемой операции:
Пример: D39004
Идентиф икатор клиентского портфеля
Пример: false
Флаг отсеивания исторических данных:
Пример: MOEX
Биржа:
Пример: Simple
Формат возвращаемого сервером JSON-объекта:
От формата объекта также зависит минимальное значение параметра frequency
для WebSocket-подписок.
Пример: 100
Частота (интервал) передачи данных сервером. Сервер вернёт последние данные по запросу за тот временной интервал, который указан в качестве значения параметра. Пример: биржа передаёт данные каждые 2 мс, но, при значении параметра 10 мс, сервер вернёт только последнее значение, отбросив предыдущие.
Минимальное значение параметра зависит от выбранного формата возвращаемого JSON-объекта:
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: eyJhbGciOiJ...
Access Токен для авторизации запроса
Ответы
Содержимое ответа, возвращаемого в WebSocket-соединение, зависит от результатов обработки запроса:
- Если запрос обработан успешно, сервер передаст в ответ одно сообщение с кодом
200
, подтверждающее создание подписки, после чего начнёт передачу сообщений с кодом100
, содержащих запрошенную в рамках подписки информацию. - Если обработка запроса завершилась неудачей, сервер передаст в ответ одно сообщение с кодом ошибки, соответствующим причине отказа, после чего закроет WebSocket-соединение.
- 100
- 200
- 401
Сообщения от канала, содержащие в себе информацию, запрошенную в рамках подписки
- Формат Simple
- Формат Slim
- Формат Heavy
- Тело ответа
- Схема
{
"data": {
"buyingPowerAtMorning": 99174.54,
"buyingPower": 99186,
"profit": 12,
"profitRate": 0.01,
"portfolioEvaluation": 99900,
"portfolioLiquidationValue": 99900,
"initialMargin": 713,
"riskBeforeForcePositionClosing": 99543,
"commission": 1.36,
"buyingPowerByCurrency": [
{
"currency": "RUB",
"buyingPower": 99186.21945092
}
]
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Пример: 99174.54
Покупательская способность на утро
Пример: 99186
Покупательская способность
Пример: 12
Прибыль за сегодня
Пример: 0,01
Норма прибыли, %
Пример: 99900
Ликвидный портфель
Пример: 99900
Оценка портфеля
Пример: 713
Маржа
Пример: 99543
Риск до закрытия
Пример: 1,36
Суммарная комиссия (null для Срочного рынка)
buyingPowerByCurrency
object
Пример: RUB
Валюта расчетов
Пример: 452404.21945092
Покупательская способность в валюте расчётов
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
- Тело ответа
- Схема
{
"data": {
"bpm": 99174.54,
"bp": 99186,
"p": 12,
"pr": 0.01,
"pe": 99900,
"plv": 99900,
"im": 713,
"r": 99542,
"cms": 1.36,
"bp2v": [
{
"cr": "RUB",
"bp": 99186.21945092
}
]
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Пример: 99174.54
Покупательская способность на утро
Пример: 99186
Покупательская способность
Пример: 12
Прибыль за сегодня
Пример: 0,01
Норма прибыли, %
Пример: 99900
Ликвидный портфель
Пример: 99900
Оценка портфеля
Пример: 713
Маржа
Пример: 99543
Риск до закрытия
Пример: 1,36
Суммарная комиссия (null для Срочного рынка)
bpv2
object
Пример: RUB
Валюта расчетов
Пример: 452404.21945092
Покупательская способность в валюте расчётов
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
- Тело ответа
- Схема
{
"data": {
"buyingPowerAtMorning": 99174.54,
"buyingPower": 99186,
"profit": 12,
"profitRate": 0.01,
"portfolioEvaluation": 99900,
"portfolioLiquidationValue": 99900,
"initialMargin": 713,
"riskBeforeForcePositionClosing": 99543,
"commission": 1.36,
"buyingPowerByCurrency": [
{
"currency": "RUB",
"buyingPower": 99186.21945092
}
]
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Пример: 99174.54
Покупательская способность на утро
Пример: 99186
Покупательская способность
Пример: 12
Прибыль за сегодня
Пример: 0,01
Норма прибыли, %
Пример: 99900
Ликвидный портфель
Пример: 99900
Оценка портфеля
Пример: 713
Маржа
Пример: 99543
Риск до закрытия
Пример: 1,36
Суммарная комиссия (null для Срочного рынка)
buyingPowerByCurrency
object
Пример: RUB
Валюта расчетов
Пример: 452404.21945092
Покупательская способность в валюте расчётов
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Сообщение об успешной обработке запроса на подписку
- Тело ответа
- Схема
{
"message": "Handled successfully",
"httpCode": 200,
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
Пример: Handled successfully
Текстовое представление возвращаемого сообщения
Пример: 200
Код возвращаемого сообщения
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Не удалось авторизовать запрос — Access Токен не указан в теле запроса, срок его действия истёк или он относится к другому контуру системы
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 401,
"message": "Invalid JWT token!"
}
Параметры тела ответа
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: 401
Код возвращаемого сообщения
Пример: Invalid JWT token!
Текстовое представление возвращаемого сообщения