Skip to main content

API reference

The API reference is the single, canonical home for every Full Integration endpoint. Each endpoint is documented once, on the domain page it belongs to. Conceptual and feature pages link here for the specs.

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

DirectionCallerCalleeAuthentication
Broker → cTraderBroker backendcTrader backendManager Token (?token={webservToken})
cTrader → broker CRMcTrader backendBroker CRMCRM API token (?crmApiToken=…)

See Authentication of API calls for how the two schemes work and the base URLs.

Domain pages