Docs
Api referenceInstruments

Read an account's symbols from its broker now

POST
/v1/accounts/{id}/symbols/sync

Reads the broker's symbol list again and remaps the instruments, for when the broker has added symbols. Needs the account online (ready); returns 409 ACCOUNT_NOT_READY otherwise. It happens on its own once a day while the account is online, so most integrations never call this.

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 a label (live or test) in the key itself, so each configuration is easy to tell apart. Both reach real brokers: test with a broker demo account.

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

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/symbols/sync"
{  "data": {    "syncedAt": "2019-08-24T14:15:22Z",    "server": "string",    "symbolCount": 0,    "utcOffsetSeconds": 10800,    "sessionsSyncedAt": null  }}