OrderFill

Symbols

What an account can trade, and how names map to it.

The concept is on Symbols. These are the calls.

GET /v1/accounts/:id/symbols

Query
qOptional. Filters either name, case-insensitively.
allOptional. true adds every symbol on the account with no canonical name.
{
  "affix": "m",
  "symbols": [
    { "canonical": "XAUUSD", "brokerSymbol": "XAUUSDm", "tradable": true, "how": "affix" },
    { "canonical": null, "brokerSymbol": "Tactical Gold Index", "tradable": true, "how": "raw" }
  ],
  "unresolved": [ { "canonical": "NZDCAD", "reason": "not offered on this account" } ]
}

GET /v1/accounts/:id/symbols/:canonical

Resolve one name. 404 if this account cannot trade it.

{ "symbol": { "canonical": "XAUUSD", "brokerSymbol": "XAUUSDm", "tradable": true, "how": "affix" } }

PUT /v1/accounts/:id/symbols

Replace the account's symbol map. Answers like GET /v1/accounts/:id/symbols, so you see where each name landed. {} clears it. Needs trade.

{ "symbolMap": { "XAUUSD": ["XAUUSDm", "GOLD"] } }

PUT /v1/accounts/:id/symbols/:canonical

Pin a canonical name to one of the account's symbols. null removes the pin. Needs trade.

{ "brokerSymbol": "GOLD" }

Returns the resolved symbol, as above.

On this page