List the symbols an account's broker offers
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 GET "https://api.fxapis.com/v1/accounts/ACCOUNT_ID/symbols" \
-H "Authorization: Bearer YOUR_API_KEY"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 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
uuidQuery Parameters
Only symbols whose name or description contains this.
Only symbols this account can, or cannot, open positions in.
Value in
- "true"
- "false"
1 <= value <= 1000200The nextCursor from the previous page.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.fxapis.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 }}List the instruments a signal can name GET
The markets fxapis names once, whatever each broker calls them: currency pairs, metals, indices, energies and crypto. A signal that names one of these as `instrument` is traded on every account under that account's own broker symbol. Needs no account and no broker.
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`).