Skip to main content

Fixing errors

📢 Dear friends! 📢

Keeping you updated on the latest changes!

✏ In this digest:

  • Removed instrumentGroup field from some WS subscriptions
  • Updated response for the Risk Rates request
  • Fixed several incorrect descriptions

And a small change for the Changelog section button.

🔽 More details inside! 🔽

Removing instrumentGroup from some WS subscriptions​

Some WebSocket subscription pages contained the instrumentGroup parameter in their request body added by mistake. The good news is that this typo did not affect the processing of those requests. The bad news is that the presence of instrumentGroup in the description created a false idea about the possible system features.

This documentation update removes the presence of instrumentGroup from the request body descriptions where it was superfluous.

Applied to requests​

WebSocket subscriptions

Incorrect description fixes​

Unrealised profit or loss​

Fixed incorrect descriptions of fields displaying unrealized profit or loss on position:

unrealisedPl / up

Before

Total profit or total loss for the day in the settlement currency

After

Aggregate unrealized profit or loss on open positions in settlement currency. Reflects the difference between the position opening and current prices

dailyUnrealisedPl / upd

Before

Total profit or total loss for the day in percent

After

Daily unrealized profit or loss on open positions in settlement currency. Shows the difference between the position price at the beginning of the current trading session and its current price

Applied to requests​

HTTP

WebSocket subscriptions

Order execution condition attheclose​

Description of the attheclose option has been supplemented with information on its behavior and scope of use:

timeInForce / tf

Before

attheclose — Execute at the moment of trading closing at the market price reached at that moment. Market orders only because the lot price depends on the market price at the moment of execution

After

attheclose — Execution at market price prevailing at the moment of market close. Available only for SPBX (automatically converted to fillorkill on MOEX) and applicable only to market orders, as the order price depends on the market price at execution time

Applied to requests​

HTTP

Deprecated HTTP

WebSocket subscriptions

WebSocket commands

The corresponding tables on the description pages for the different types of applications have been updated to match the changes in the parameter description.

Updated response for Risk Rates request​

The response to the Risk Rates request has been updated in two ways:

  1. The isDirect field (boolean) has been replaced with a new field sngR (int32), which serves the same purpose but uses different possible values. Complete description for this field is available at the request description page.
  2. The fields CreatedAt, UpdatedAt, and UpdatedBy have been completely removed from the response. These were intended for internal use only and were mistakenly exposed in the public API.

We recommend updating your software to avoid response processing errors.

Changelog button changes​

Some users were confused by the "Changes" button previously located on the right side of the screen — it looked similar to the "Developer's Cabinet" button and visually merged with it. At their request, the button has been replaced with a simple link and moved to the left side of the navigation panel, among other documentation portal section links.

Feel free to contact us in any convenient way if you have any questions about the system:

If you have ideas for further system development, feel free to send them to us via the Feedback portal.

Thanks for helping us make the system better!