Platforms

Open a cTrader Web Terminal session

Use this method to obtain a URL that logs the client in to the cTrader Web Terminal without asking for the trading account credentials. The URL carries a one-time authentication code that expires within about a minute, so it must be opened right away and cannot be reused. Request a new URL for every login. The account must belong to the authenticated client and be hosted on a cTrader platform with a configured Web Terminal URL, otherwise `404` is returned.

POST
/api/v2/my/ctrader/accounts/{account}/web-terminal/session

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

account*integer

The identifier of the cTrader trading account to open in the terminal.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/my/ctrader/accounts/1/web-terminal/session" \  -H "Content-Type: application/json" \  -d '{}'
{  "url": "https://app.ctrader.com/?authCode=1f0c94ae-8b4d-4a5a-9c31-2c1f6b0d7e4a&u=1234567&acc=90000001&theme=dark"}
{  "error": {    "message": "Bad Request",    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}
{  "error": {    "message": "Unauthorized"  }}
{  "error": {    "message": "Forbidden"  }}
{  "error": {    "message": "Not Found"  }}
{  "error": {    "message": "Too Many Requests"  }}