WebServices API

The WebServices API lets you integrate the cTrader backend with your registration forms, traders' room and CRM systems.

This REST API includes all essential operations including (but not limited to) account creation, cTID creation, group assignment, performing deposits and withdrawals, requesting balance and linking accounts to cTID.

This documentation includes detailed descriptions of all endpoints in the WebServices API; it also contains the JSON schemas for all major server entities.

In this section:

📄️ Domain model and logic

The cTrader WebServices domain model: plants, environments, brokers, cTIDs and accounts (traders), and how they link.

📄️ General provisions

General provisions for using the WebServices API, including access requirements and request conventions.

📄️ Operations with accounts

WebServices API calls for managing traders (accounts): creation, updates, balances, positions and attributes.

📄️ Operations with cTID

WebServices API calls for managing cTID entities (users) and linking accounts to them.

📄️ Operations with symbols and assets

WebServices API calls for reading the assets and symbols available on a server.

📄️ JSON schemas

JSON schemas for the major cTrader server entities you operate on through the WebServices API.

📄️ Use cases

Common WebServices API use cases with the required API calls and request and response examples.

📄️ Error codes and descriptions

Error codes you may encounter when working with the WebServices API, with descriptions.

📄️ Best practices

Best practices for CRM and client-area systems integrating with the WebServices API.

📄️ Country list

Reference list of countries, countryIds and Alpha-2 codes used by the WebServices API.