Theme switcher

Get Candles

Header Parameters

Authorizationstring Required

Bearer token issued for your trading account.

Query Parameters

symbolstring Required

Instrument to return candles for. One instrument per call.

intervalstring Required

Candle length. M1, M5, M15, and M30 are minutes, H1 and H4 are hours, D1 is one day, W1 is one week, and MN1 is one month. An unsupported value returns 400 error://trader-api/candle-interval-invalid.

Enum values:
M1M5M15M30H1H4D1W1MN1
frominteger

Start of the time range.

tointeger

End of the time range.

limitinteger

Number of candles to return. Defaults to 100, maximum 750.

Minimum
1
Maximum
750
Default value
100

Response

200
Object

OK

Response Attributes

symbolstring

Instrument the candles belong to.

intervalstring

Interval the candles were aggregated at.

Enum values:
M1M5M15M30H1H4D1W1MN1
candlesarray

The candles, ordered from oldest to newest.

Show child attributes

400
Object

error://trader-api/trading-validation-failed, error://trader-api/candle-interval-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/trading-validation-failederror://trader-api/candle-interval-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.

404
Object

error://trader-api/symbol-not-found

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-not-found
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?