Read an account's symbols from its broker now
Last updated:
Request
Synthetic example for the production API. Replace YOUR_API_KEY and the ids. Do not send it against a live account until you mean to.
curl -X POST "https://api.fxapis.com/v1/accounts/ACCOUNT_ID/symbols/sync" \
-H "Authorization: Bearer YOUR_API_KEY"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 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
application/json
curl -X POST "https://api.fxapis.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 }}Market hours for a symbol or instrument, from the account's broker GET
When the account's broker lets orders be placed in a symbol — or in this account's symbol for an instrument — as the broker configured it (MetaTrader's `SymbolInfoSessionTrade`), with whether it is open now and when that next changes. `trade` and `quote` are given in the broker's server time and in UTC; `utcOffsetSeconds` is the broker's clock as measured when the sessions were read. Read when the account comes online and refreshed daily, so it answers while the account is offline. Holidays a broker does not load into its schedule are not here: on such a day an order is still refused with `ORDER_REJECTED` (`Market closed`).
See how each instrument maps onto an account's broker GET
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.