Skip to main content

Portfolio summary

Private resource

The request cannot be executed anonymously. The required token parameter must contain an up-to-date Access Token.

HTTP API

This operation can be performed with request to HTTP API.

The request creates a subscription to receive summary information about the specified portfolio.

Request​

To create a subscription to a data channel, send a message to the established WebSocket connection with a request body containing the details of the subscription to be created.

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

Responses​

The content of the response returned to the WebSocket connection depends on the results of processing the request:

  • If the request is processed successfully, the server will send one 200 code message in response, confirming that the subscription has been created, after which it will begin transmitting 100 code messages containing the information requested as part of the subscription.
  • If the request processing failed, the server will send back one message with an error code corresponding to the reason for the failure, after which it will close the WebSocket connection.

Messages from the channel containing the requested information

{
  "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"
}