See how each instrument maps onto an account's broker
For every instrument, the symbol an order naming it will trade on this account — or why it cannot: the broker has several plausible symbols (ambiguous, with candidates), or does not offer it (missing). Useful when a member connects, to tell them which signals their account can follow.
A symbol is mapped automatically only when its name matches and, where the market has one standard contract, its contract size agrees: gold quoted per gram is never taken for gold per ounce.
Returns 409 SYMBOLS_NOT_SYNCED for an account that has never been online.
Authorization
apiKey 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
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08/instruments"{ "data": [ { "instrument": "XAUUSD", "name": "string", "category": "forex", "status": "mapped", "symbol": "XAUUSD.a", "reason": "its name once the broker's suffix is removed, contract size agrees", "candidates": [ { "symbol": "string", "confidence": 0, "reason": "string" } ] } ], "meta": { "syncedAt": "2019-08-24T14:15:22Z", "server": "string", "symbolCount": 0, "utcOffsetSeconds": 10800, "sessionsSyncedAt": null }}