Skip to main content

Quick Start Guides

Interaction with the ALOR Broker trading system API is not limited to sending requests to HTTP API or WebSocket API. The user must also perform (either once or regularly) a number of additional actions to confirm the right to access the requested resources. The Quick Start Guide aims to describe a complete step-by-step sequence of actions that will lead the user to successfully fulfill requests.

The Quick Start Guide is prepared primarily for users interacting with the API directly and performing operations using their personal trading account, therefore the JSON Web Token mechanism was used for requests authorization. For developers of third-party applications, through which their users will interact with the trading system, the OAuth 2.0 authorization service is available to help automate the authorization of requests.

The user is free to choose the tools and methods of realization of the tasks at hand. However, since it is impossible to include all possible interaction options within one guide, one of the most easy-to-implement options will be provided in the places where an example is required. For example, when working with WebSocket API, it is necessary to establish a WebSocket connection to one of the available interfaces, within which all subsequent requests will be executed. Due to the wide variety of programming languages and libraries suitable for this task, each new implementation may differ greatly from the previous one. In the Quick Start Guide, this task will be solved using the Postman API testing tool.

The user through the API can interact with two environments of the trading system:

  • Production environment, which provides access to real exchange data, securities, positions and trades;
  • Test Environment, providing access to a sandbox with simulated data in which the user can test his queries and applications.

Despite that both environments have identical architecture, the interaction with them is slightly different. Because of this, each environment has its own version of the Quick Start Guide.

What's next?​

Additionally, we recommend reading the following related articles: