Docs
Api referenceInstruments

List the instruments a signal can name

GET
/v1/instruments

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
AuthorizationBearer <token>

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

category?string

Only this category.

Value in

  • "forex"
  • "metals"
  • "indices"
  • "energies"
  • "crypto"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/instruments"
{  "data": [    {      "instrument": "XAUUSD",      "name": "Gold vs US Dollar",      "category": "forex"    }  ]}