Портфельные риски

Приватный ресурс

Запрос нельзя выполнить анонимно. Обязательный параметр token должен содержать актуальный Access Токен.

HTTP API

Для этой операции есть альтернативный HTTP-запрос.

Запрос создаёт подписку на получение сводной информации по портфельным рискам для указанного портфеля.

Запрос

Для создания подписки на информационный канал отправьте в установленное WebSocket-соединение сообщение с телом запроса, содержащим детали создаваемой подписки.

Тело запроса
Схема

{
  "opcode": "RisksGetAndSubscribe",
  "portfolio": "D39004",
  "skipHistory": false,
  "exchange": "MOEX",
  "instrumentGroup": "TQBR",
  "format": "Simple",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "token": "eyJhbGciOiJ..."
}

Параметры тела запроса

opcodestringrequired

Код выполняемой операции:

OrderBookGetAndSubscribe — Подписка на биржевой стакан
BarsGetAndSubscribe — Подписка на историю цен (свечи)
QuotesSubscribe — Подписка на информацию о котировках
InstrumentsGetAndSubscribeV2 — Подписка на изменение информации о финансовых инструментах на выбранной бирже
AllTradesGetAndSubscribe — Подписка на все сделки
PositionsGetAndSubscribeV2 — Подписка на информацию о текущих позициях по торговым инструментам и деньгам
SummariesGetAndSubscribeV2 — Подписка на сводную информацию по портфелю
RisksGetAndSubscribe — Подписка на сводную информацию по портфельным рискам
SpectraRisksGetAndSubscribe — Подписка на информацию по рискам срочного рынка (FORTS)
TradesGetAndSubscribeV2 — Подписка на информацию о сделках
OrdersGetAndSubscribeV2 — Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструмента
StopOrdersGetAndSubscribeV2 — Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструмента
unsubscribe — Отмена существующей подписки

portfoliostringrequired

Идентификатор клиентского портфеля

Пример: D39004

skipHistoryboolean

Флаг отсеивания исторических данных:

true — отображать только новые данные
false — отображать в том числе данные из истории

Пример: false

exchangestringrequired

Биржа:

MOEX — Московская Биржа
SPBX — СПБ Биржа

Пример: MOEX

instrumentGroupstring

Код режима торгов (Борд):

Для Московской Биржи список кодов доступен в таблице
Для Биржи СПБ всегда SPBX

Пример: TQBR

formatstring

Формат возвращаемого сервером JSON-объекта:

Simple — оригинальный формат данных. Поддерживает устаревшие параметры для обеспечения обратной совместимости
Slim — облегчённый формат данных для быстрой передачи сообщений. Не поддерживает устаревшие параметры
Heavy — полный формат данных, развивающийся и дополняющийся новыми полями. Не поддерживает устаревшие параметры

От формата объекта также зависит минимальное значение параметра frequency для WebSocket-подписок.

Пример: Simple

guidstringrequired

Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

tokenstringrequired

Access Токен для авторизации запроса

Пример: eyJhbGciOiJ...

Ответы

Содержимое ответа, возвращаемого в WebSocket-соединение, зависит от результатов обработки запроса:

Если запрос обработан успешно, сервер передаст в ответ одно сообщение с кодом 200, подтверждающее создание подписки, после чего начнёт передачу сообщений с кодом 100, содержащих запрошенную в рамках подписки информацию.
Если обработка запроса завершилась неудачей, сервер передаст в ответ одно сообщение с кодом ошибки, соответствующим причине отказа, после чего закроет WebSocket-соединение.

Сообщения от канала, содержащие в себе информацию, запрошенную в рамках подписки

Формат Simple
Формат Slim
Формат Heavy

Тело ответа
Схема

{
  "data": {
    "portfolio": "D39004",
    "exchange": "MOEX",
    "portfolioEvaluation": 99894.638950,
    "portfolioLiquidationValue": 99894.638950,
    "initialMargin": 711.11454750,
    "minimalMargin": 355.557273750,
    "correctedMargin": 711.11454750,
    "riskCoverageRatioOne": 99183.52440250,
    "riskCoverageRatioTwo": 99539.081676250,
    "riskCategoryId": 1,
    "clientType": "StandardRisk",
    "hasForbiddenPositions": false,
    "hasNegativeQuantity": false,
    "riskStatus": "Ok"
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Параметры тела ответа

data

object

Блок данных от информационного канала

portfoliostring

Идентификатор клиентского портфеля

Пример: D39004

exchangestring

Биржа:

MOEX — Московская Биржа
SPBX — СПБ Биржа

Пример: MOEX

portfolioEvaluationdecimal

Общая стоимость портфеля

Пример: 99894.638950

portfolioLiquidationValuedecimal

Стоимость ликвидного портфеля

Пример: 99894.638950

initialMargindecimal

Начальная маржа

Пример: 711.11454750

minimalMargindecimal

Минимальная маржа

Пример: 355.557273750

correctedMargindecimal

Скорректированная маржа

Пример: 711.11454750

riskCoverageRatioOnedecimal

НПР1

Пример: 99183.52440250

riskCoverageRatioTwodecimal

НПР2

Пример: 99539.081676250

riskCategoryIdint32

Категория риска.

Пример: 1

clientTypestring

Тип клиента:

StandardRisk — Стандартный уровень риска (КСУР)
HighRisk — Высокий уровень риска (КПУР)
Special — Особый уровень риска (КОУР)

Пример: StandardRisk

hasForbiddenPositionsboolean

Имеются ли запретные позиции

Пример: false

hasNegativeQuantityboolean

Имеются ли отрицательные количества

Пример: false

riskStatusstring

Статус клиента согласно его уровня риска, рассчитанного на основе показателей НПР1 и НПР2. Определяет возможность ведения маржинальной торговли:

Ok — уровень риска в норме. Доступны любые операции с маржинальными позициями, включая открытие новых (НПР1≥0, НПР2≥0);
Demand — уровень, требующий повышенного внимания к рискам. Доступны операции по уменьшению и закрытию существующих маржинальных позиций, но запрещено открытие новых (НПР1<0, НПР2≥0);
ToClose — критический уровень риска, при котором открытые позиции могут быть принудительно закрыты (НПР1<0, НПР2<0).

Пример: Ok

guidstring

Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

Тело ответа
Схема

{
  "data": {
    "p": "D39004",
    "ex": "MOEX",
    "pe": 99894.638950,
    "plv": 99894.638950,
    "mgi": 711.11454750,
    "mgmn": 355.557273750,
    "mgc": 711.11454750,
    "r1": 99183.52440250,
    "r2": 99539.081676250,
    "rid": 1,
    "ct": "StandardRisk",
    "fpos": false,
    "nq": false,
    "rst": "Ok"
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Параметры тела ответа

data

object

Блок данных от информационного канала

pstring

Идентификатор клиентского портфеля

Пример: D39004

exstring

Биржа:

MOEX — Московская Биржа
SPBX — СПБ Биржа

Пример: MOEX

pedecimal

Общая стоимость портфеля

Пример: 99894.638950

plvdecimal

Стоимость ликвидного портфеля

Пример: 99894.638950

mgidecimal

Начальная маржа

Пример: 711.11454750

mgmndecimal

Минимальная маржа

Пример: 355.557273750

mgcdecimal

Скорректированная маржа

Пример: 711.11454750

r1decimal

НПР1

Пример: 99183.52440250

r2decimal

НПР2

Пример: 99539.081676250

ridint32

Категория риска.

Пример: 1

ctstring

Тип клиента:

StandardRisk — Стандартный уровень риска (КСУР)
HighRisk — Высокий уровень риска (КПУР)
Special — Особый уровень риска (КОУР)

Пример: StandardRisk

fposboolean

Имеются ли запретные позиции

Пример: false

nqboolean

Имеются ли отрицательные количества

Пример: false

rststring

Ok — уровень риска в норме. Доступны любые операции с маржинальными позициями, включая открытие новых (НПР1≥0, НПР2≥0);
Demand — уровень, требующий повышенного внимания к рискам. Доступны операции по уменьшению и закрытию существующих маржинальных позиций, но запрещено открытие новых (НПР1<0, НПР2≥0);
ToClose — критический уровень риска, при котором открытые позиции могут быть принудительно закрыты (НПР1<0, НПР2<0).

Пример: Ok

guidstring

Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

Тело ответа
Схема

{
  "data": {
    "portfolio": "D39004",
    "exchange": "MOEX",
    "portfolioEvaluation": 99894.638950,
    "portfolioLiquidationValue": 99894.638950,
    "initialMargin": 711.11454750,
    "minimalMargin": 355.557273750,
    "correctedMargin": 711.11454750,
    "riskCoverageRatioOne": 99183.52440250,
    "riskCoverageRatioTwo": 99539.081676250,
    "riskCategoryId": 1,
    "clientType": "StandardRisk",
    "hasForbiddenPositions": false,
    "hasNegativeQuantity": false,
    "riskStatus": "Ok"
  },
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Параметры тела ответа

data

object

Блок данных от информационного канала

portfoliostring

Идентификатор клиентского портфеля

Пример: D39004

exchangestring

Биржа:

MOEX — Московская Биржа
SPBX — СПБ Биржа

Пример: MOEX

portfolioEvaluationdecimal

Общая стоимость портфеля

Пример: 99894.638950

portfolioLiquidationValuedecimal

Стоимость ликвидного портфеля

Пример: 99894.638950

initialMargindecimal

Начальная маржа

Пример: 711.11454750

minimalMargindecimal

Минимальная маржа

Пример: 355.557273750

correctedMargindecimal

Скорректированная маржа

Пример: 711.11454750

riskCoverageRatioOnedecimal

НПР1

Пример: 99183.52440250

riskCoverageRatioTwodecimal

НПР2

Пример: 99539.081676250

riskCategoryIdint32

Категория риска.

Пример: 1

clientTypestring

Тип клиента:

StandardRisk — Стандартный уровень риска (КСУР)
HighRisk — Высокий уровень риска (КПУР)
Special — Особый уровень риска (КОУР)

Пример: StandardRisk

hasForbiddenPositionsboolean

Имеются ли запретные позиции

Пример: false

hasNegativeQuantityboolean

Имеются ли отрицательные количества

Пример: false

riskStatusstring

Ok — уровень риска в норме. Доступны любые операции с маржинальными позициями, включая открытие новых (НПР1≥0, НПР2≥0);
Demand — уровень, требующий повышенного внимания к рискам. Доступны операции по уменьшению и закрытию существующих маржинальных позиций, но запрещено открытие новых (НПР1<0, НПР2≥0);
ToClose — критический уровень риска, при котором открытые позиции могут быть принудительно закрыты (НПР1<0, НПР2<0).

Пример: Ok

guidstring

Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

Сообщение об успешной обработке запроса на подписку

Тело ответа
Схема

{
  "message": "Handled successfully",
  "httpCode": 200,
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}

Параметры тела ответа

messagestring

Текстовое представление возвращаемого сообщения

Пример: Handled successfully

httpCodeint32

Код возвращаемого сообщения

Пример: 200

requestGuidstring

Уникальный идентификатор запроса. Значением выступает параметр guid, указанный в теле запроса

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

Не удалось авторизовать запрос — Access Токен не указан в теле запроса, срок его действия истёк или он относится к другому контуру системы

Тело ответа
Схема

{
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "httpCode": 401,
  "message": "Invalid JWT token!"
}

Параметры тела ответа

requestGuidstring

Уникальный идентификатор запроса. Значением выступает параметр guid, указанный в теле запроса

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

Код возвращаемого сообщения

Пример: 401

messagestring

Текстовое представление возвращаемого сообщения

Пример: Invalid JWT token!

Портфельные риски

Запрос​

Параметры тела запроса

Ответы​

Параметры тела ответа

Параметры тела ответа

Параметры тела ответа

Параметры тела ответа

Параметры тела ответа

Запрос

Ответы