Skip to main content

Minor documentation Fixes

📢 Dear friends! 📢

Keeping you updated on the latest changes!

✏ In this digest:

  • Fixed an error in the condition parameter
  • Slightly expanded descriptions of volume and currentVolume parameters
  • Added clarification to the protectingSeconds parameter description
  • Specified value types for the id parameter in trade requests

🔽 More details inside! 🔽

Error in the condition parameter​

A small error was found in the condition parameter description — possible values were listed in PascalCase (e.g., MoreOrEqual), while the system actually uses flatcase (e.g., moreorequal).

The difference may seem minor, but it caused issues in third-party software, as the system expects and returns values entirely in lowercase. The parameter description has now been aligned with actual system behavior.

Applied to requests​

HTTP

WebSocket subscriptions

WebSocket commands

Descriptions of volume and currentVolume​

Minor clarifications have been added regarding the meaning of "volume" fields in position and trade retrieval requests. We recommend reviewing the updated definitions on the respective endpoint pages.

Applied to requests​

HTTP

WebSocket subscriptions

Description of protectingSeconds​

A small fix inspired by user questions.

The protectingSeconds parameter description refers to the trigger price of a conditional order, labeled as triggerPrice. However, this field is named triggerPrice only when creating an order, while in responses listing orders, the same value is called stopPrice. For clarity, both names are now included in the protectingSeconds description.

Applied to requests​

HTTP

WebSocket subscriptions

WebSocket commands

id Value Types​

The system returns trade identifiers in two data types: string for personalized data requests (when getting trades by portfolio) and long for anonymous ones (when getting all trades by instrument). Until the last update, this distinction was not documented. Well, now it is.

Applied to requests​

HTTP

WebSocket subscriptions

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!