Docs
Api referenceInstruments

List the symbols an account's broker offers

GET
/v1/accounts/{id}/symbols

Every symbol the account's broker offers it, with its contract specification, as read from the broker when the account was last online — so it answers while the account is offline. Refreshed each time the account comes online and the list is a day old. syncedAt says when.

Returns 409 SYMBOLS_NOT_SYNCED for an account that has never been online.

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

Query Parameters

search?string

Only symbols whose name or description contains this.

tradable?string

Only symbols this account can, or cannot, open positions in.

Value in

  • "true"
  • "false"
limit?integer
Range1 <= value <= 1000
Default200
cursor?string

The nextCursor from the previous page.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/symbols"
{  "data": [    {      "name": "XAUUSD.a",      "description": "Gold vs US Dollar",      "path": "Metals\\XAUUSD.a",      "digits": 2,      "contractSize": 100,      "volumeMin": 0.01,      "volumeMax": 50,      "volumeStep": 0.01,      "tradable": true,      "sessions": null,      "currencyBase": "string",      "currencyProfit": "string",      "currencyMargin": "string"    }  ],  "meta": {    "syncedAt": "2019-08-24T14:15:22Z",    "server": "string",    "symbolCount": 0,    "utcOffsetSeconds": 10800,    "sessionsSyncedAt": null  },  "page": {    "hasMore": true,    "nextCursor": null  }}