Theme switcher

Get Symbols

Header Parameters

Authorizationstring Required

Bearer token issued for your trading account.

Query Parameters

symbolarray

Instrument to return. Repeat the parameter for several instruments; omit it to return every instrument available to your account.

typearray

Instrument type to filter by: FOREX, CFD, FOREXCFD, or PRED. Repeat the parameter for several types; omit it to return all of them. Combined with symbol, only instruments that match both filters are returned. An unsupported value returns 400 error://trader-api/symbol-type-invalid.

Enum values:
FOREXCFDFOREXCFDPRED

Response

200
Object

OK

Response Attributes

symbolsarray

Instruments available to your account, one entry per instrument.

Show child attributes

400
Object

error://trader-api/symbol-type-invalid

Response Attributes

pathstring Required

The request path with the actual identifiers filled in, without query parameters.

statusinteger Required

The HTTP status code, the same as the response status.

typestring Required

A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.

Enum values:
error://trader-api/symbol-type-invalid
titlestring Required

A short, human-readable name of the error. Several types can share the same title.

detailstring Required

A description of this particular occurrence. The wording can change, so never parse it or base logic on it.

additionalInfoobject | null

Extra information as key-value pairs.

401
Object

error://trader-api/unauthorized

Response Attributes

pathstring Required

The request path with the actual identifiers filled in, without query parameters.

statusinteger Required

The HTTP status code, the same as the response status.

typestring Required

A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.

Enum values:
error://trader-api/unauthorized
titlestring Required

A short, human-readable name of the error. Several types can share the same title.

detailstring Required

A description of this particular occurrence. The wording can change, so never parse it or base logic on it.

additionalInfoobject | null

Extra information as key-value pairs.

403
Object

error://trader-api/forbidden

Response Attributes

pathstring Required

The request path with the actual identifiers filled in, without query parameters.

statusinteger Required

The HTTP status code, the same as the response status.

typestring Required

A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.

Enum values:
error://trader-api/forbidden
titlestring Required

A short, human-readable name of the error. Several types can share the same title.

detailstring Required

A description of this particular occurrence. The wording can change, so never parse it or base logic on it.

additionalInfoobject | null

Extra information as key-value pairs.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?