API Trading

API Trading


API Trading allows traders to automate routine tasks related to market analysis and opening positions, such as collecting information about an asset, building complex mathematical models, performing numerous calculations, and opening and closing trades in seconds.

It is worth noting that this type of trading helps eliminate human factors (emotions, intuition, assumptions, and inaccurate forecasts) when making trading decisions.

Obtaining the Required Authorization Details

WEB API Token

  1. In your personal account, click the three-dot menu next to the relevant trading account.
  2. Select WEB API Tokens.
A window will appear displaying the details for the selected trading account:



A newly created Web API token has Readonly access rights by default. This allows you to view all account information, but placing orders and performing other trading operations is not permitted.

If you plan to trade via API, you will need to change the access rights manually:

  1. In your Personal Account, click the additional options button (three dots) next to the required trading account.
  2. Select Web API-tokens.
  3. In the token card, click Edit.
  4. Under Access rights, select the required option and click Save.

Available access rights:

  • Readonly - allows you to view account information, but does not permit trading operations (default setting).
  • Full - grants full access, including placing orders and performing trading operations.
  • Blocked - the token is blocked and cannot be used.

Obtaining the API ID, API Secret, and API Key

  1. Open the trading platform and click your trading account number in the top-right corner.



  1. In the window that appears select Edit User Account



  1. Click Next at the bottom of the page:



  1. Then click Create new WebAPI Token – Yes:

  1. That's it! The process is complete. Make sure to save or copy the generated credentials for future use.

Please note the token status. By default, a newly created WEB API token has read-only permissions. This allows you to view all account information, but placing orders and performing other trading operations is not permitted.

If you plan to trade via API, you’ll need to manually change the token status to Full in the token settings after creating it.

Practical Use of API Requests

We will use the following Swagger documentation.

Testing GET Requests

  1. To test requests you need to enter the details obtained in Step 1.


  1. Follow these steps to test GET requests:
1. Select required request from the relevant group:


2. Expand the request, click the corresponding button, and then click Execute:



3. You can then review the request results:



Testing POST Requests

For safety reasons do not test requests that open or close trades. Other POST requests may require additional input parameters, such as the start and end dates of a period.

  1. Click Try it out to test the request:



  2. Enter the required and optional parameters:
    Info
    The available parameters are indicated in the beginning of each POST request description. Optional means that a parameter is not required and can be omitted. Required means that the parameter must be specified for the request.



  3. Here is the example of the parameters to retrieve the trading history for an account:



  4. Click Execute to view the results below:



To view code examples, click the Examples tab. This opens a pop-up window:



In the pop-up window select the programming language you are interested in.




You will then be redirected to a GitHub repository containing the documentation and code examples. You can create your own working copy and modify the code to suit your requirements.

Alert
GitHub repository is managed by an independent company. When registering on GitHub, users are asked to accept the service's terms of use, set out in the GitHub Terms of Service document.

Under these terms you own the content you create but grant GitHub certain rights to display and share it. You retain control over your content and remain responsible for it. The rights granted to GitHub are limited to those necessary to provide the service. GitHub reserves the right to remove content or close accounts when necessary. Before using the GitHub repository we recommend to carefully review the GitHub Terms of Service.

Please also be careful when handling personal data in the GitHub repository. We recommend that you do not include personal information in your source code, code snippets, or elsewhere. This includes your name, address, contact details, account information, and other personal data.