API reference
The API reference is the single, canonical home for every endpoint used in full integration. Each endpoint is documented once, on the domain page it belongs to. Conceptual and feature pages link here for the specs.
In this section:
📄️ Authentication
Endpoints that establish the two authentication schemes.
📄️ Users and accounts
Endpoints for creating and managing users and trading accounts.
📄️ Balances
Endpoint for changing a trader's balance.
📄️ Partner attribution
Endpoints for setting, reading and deleting a partner identifier.
📄️ In-app controls
Endpoint for creating or updating in-app controls (ribbons).
📄️ Token verification and session
Broker CRM endpoints that cTrader calls to verify tokens and manage sessions.
📄️ Error codes
HTTP status codes and SSO (OAuth) specific error codes returned across the API.
How to read an entry
Each endpoint entry lists, in order: method and path, caller and callee, authentication, path/query parameters, request body, output, expected status code, errors, and a curl example.
Endpoint paths are relative to the base URLs described in Authentication of API calls — entries state which base applies and link to it rather than restating the URLs.
Caller and callee
| Direction | Caller | Callee | Authentication |
|---|---|---|---|
| Broker → cTrader | Broker backend | cTrader backend | manager token (?token={webservToken}) |
| cTrader → broker CRM | cTrader backend | Broker CRM | CRM API token (?crmApiToken=…) |
See Authentication of API calls for how the two schemes work and the base URLs.