Skip to main content

WebServices API

WebServices API Definition​

The WebServices API is a powerful API that allows for integrating the cTrader backend with one's 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.

Structure of the Documentation​

The WebServices API documentation includes the following sections.

  • Domain model and logic provides a general overview of the cTrader domain model and logic.
  • General provisions outlines the general provisions for working with the API.
  • Operations with accounts details the API calls made when working with account entities ('traders').
  • Operations with cTID defines the API calls made when working with cTID entities ('users').
  • Operations with symbols and assets outlines the API calls made when working with assets and symbols.
  • JSON schemas contains the JSON schemas for major server entities.
  • Use cases details what calls you should make when performing commonly made actions.
  • Error codes outlines the custom error codes and their descriptions.
  • Best practices provides some of the best practices that you should follow when integrating with the WebServices API.
  • Country list contains the list of countries and their IDs that you can use when performing operations with accounts.