Docs
Accounts

Connect an MT5 account

POST
/v1/accounts

Stores the account and encrypts its password. It does not log in: the account lands in created, and connects when you bring it online or when the first order arrives on a warm_on_demand account.

Authorization

apiKey
AuthorizationBearer <token>

Authorization: Bearer fx_live_<id>_<secret>.

A key is shown once, at creation. We cannot show it again or recover it for you. Keys carry an environment (live or test) in the key itself, so a test key pasted into a production config fails immediately instead of at the worst possible moment.

Scopes are per key. A key without accounts:write can read accounts and nothing else.

In: header

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/v1/accounts" \  -H "Content-Type: application/json" \  -d '{    "login": "26177561",    "server": "VantageMarkets-Demo",    "password": "your-mt5-trading-password"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "label": null,    "login": "string",    "server": "string",    "mode": "always_on",    "state": "created",    "stateDetail": null,    "stateChangedAt": "2019-08-24T14:15:22Z",    "currency": null,    "leverage": null,    "marginMode": null,    "tradeAllowed": null,    "brokerName": null,    "tradingDisabled": true,    "createdAt": "2019-08-24T14:15:22Z"  }}