List the instruments a signal can name
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/instruments" \
-H "Authorization: Bearer YOUR_API_KEY"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.
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
Query Parameters
Only this category.
Value in
- "forex"
- "metals"
- "indices"
- "energies"
- "crypto"
Response Body
application/json
application/json
application/json
curl -X GET "https://api.fxapis.com/v1/instruments"{ "data": [ { "instrument": "XAUUSD", "name": "Gold vs US Dollar", "category": "forex" } ]}Take an account offline POST
Takes the account offline and keeps it, with its stored password, in `standby` — ready to be brought online again. Open positions are untouched: a stop loss or take profit is held by the broker and keeps working while the account is offline. Returns 409 while an order is in flight. Going offline then would turn a known outcome into an unknown one, and a retry on top of that is a duplicate trade.
List the symbols an account's broker offers GET
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.