Skip to main content

Recommendations, specifications, integrations

📢 Dear friends! 📢

Keeping you updated on the latest changes!

✏ В этом дайджесте:

  • Social Rating system explanation
  • Updated Recommendations and Limits
  • Revamped SDK and Tools section
  • Downloadable OpenAPI and AsyncAPI specs
  • New derivativesDebt field
  • Various fixes and clarifications

🔽 Details below 🔽

Social Rating​

A while ago we updated the article about Protective Blocking, expanding it into a full description of the System Protection. Since this change was published without a separate announcement, we’re documenting it retroactively to preserve the history of changes and to help those who haven’t seen the new article yet.

We’ve added documentation for the Social Rating mechanism, which protects the system from excessive load caused by certain user scenarios. Different actions are assigned points by the system, and once a threshold is reached, access to the system may be restricted.

For clarity, the article includes examples of actions and their point values. We deliberately do not disclose the exact threshold values to prevent abuse.

We recommend reading the updated article — it will help you work with the system more predictably.

Affected pages

Recommendations and Limits​

Just like with the previous example, some time ago we updated the article on Fair Usage Principles, replacing it with a new article titled Limits and recommendations when working with the system. We had previously mentioned this update in our MAX channel, but didn’t record it separately in the changelog. So yes, this is another retrospective entry — to preserve history and to help users who haven’t yet seen the updated documentation.

The new article brings together all current system restrictions, describes undesirable user scenarios, and explains the conditions for access restriction in case of systematic violation of the recommendations.

Like the System Protection, these restrictions are aimed at protecting the system from excessive load caused by specific API usage patterns. However, these are different mechanisms that use separate conditions and criteria for restricting access.

In addition to publishing the new article, we updated the HTTP API, WebSocket API, and GraphQL API pages — adding information about limits specific to each interface. We also published a new article Interface Comparison to help you choose the most suitable interface for your tasks.

We highly recommend reviewing the updated articles, especially if you actively use the API in automated scenarios.

Affected pages

SDK and Tools​

Along with the other changes in this update, we reworked the Examples and Tools article, which is now called SDKs & Tools.

The update affected both the structure and the content of the article. We expanded the list of real applications and libraries working with our API, and finally added links to the official SDK developed by our team, which has been available for some time.

We recommend checking out the updated section for anyone who is already developing or planning to develop solutions based on ALOR API — especially those looking for ready-made tools and wanting to save time on integration.

Affected pages

Downloadable Specifications​

With this update, the documentation now offers the ability to download specification files in the appropriate standards — OpenAPI spec for HTTP API and AsyncAPI spec for WebSocket API.

These downloadable specifications can be used for automatic client generation, schema validation, and other machine processing scenarios. The files are updated along with the main documentation, keeping them current.

You can download the files using the corresponding buttons on the HTTP API and WebSocket API overview pages.

For GraphQL, access to the schemas and links to them remains unchanged, but the description of how to obtain them and authorize requests has moved to the new Schema access article.

We hope the new specifications will be useful for your application development!

Affected pages

New derivativesDebt Field​

For futures and UMP portfolios, a new field derivativesDebt (dd in Slim format) has been added to the API. It allows you to track current debt on derivatives market margin.

This field helps you detect insufficient funds in advance and avoid situations where the need to add funds only becomes known from the broker’s report after interest is charged on a negative balance.

For the derivatives market, the value is calculated based on the moneyFree and varMargin fields:

  • if the sum of the values is greater than or equal to 0, derivativesDebt is returned as 0;
  • if the sum of the values is less than 0, derivativesDebt returns the negative value of that sum.

For UMP portfolios, the T0 stock market limit is also taken into account. In cases where UMP data is unavailable or has not been confirmed by current limit settings, the value of derivativesDebt may be returned as null.

For all other portfolio types, the field value is always null.

Applied to requests​

HTTP

WebSocket subscriptions

Bug Fixes and Clarifications​

Since the last documentation update, several inaccuracies were discovered. Some of them were identified thanks to reports from users.

As part of the fixes:

  • we clarified the descriptions of the portfolioEvaluation and portfolioLiquidationValue fields in summary and risk requests — previously their definitions were mixed up and less informative;
  • we corrected the name of the corrected margin field in the Slim-format response for portfolio summary requests — the field is returned as cm, not mgc as previously stated in the documentation;
  • in the WebSocket schemas for order modification and deletion requests, the orderId parameter was incorrectly specified, causing the side parameter to be displayed twice in the schema.

A special thank you to everyone who helped find these errors! With your help, the documentation keeps getting better.

Applied to requests​

HTTP

WebSocket subscriptions

WebSocket commands

If you have any questions about the platform, feel free to contact us through any of the following channels:

Got ideas on how we can improve the system? Share them via our Feedback Portal.

Thanks for helping us improve!