Skip to main content
GET
Get price candles for an instrument

Authorizations

x-api-key
string
header
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"e0245e0b-362b-4f73-85e7-43a7cfb2a9e9"

Path Parameters

instrumentId
integer<int32>
required

eToro instrument id, e.g. 1001 for AAPL.

Required range: x >= 1

Query Parameters

interval
enum<string>
required

Candle interval.

Available options:
1m,
5m,
10m,
15m,
30m,
1h,
4h,
1d,
1w
from
string<date-time>

Inclusive lower bound on candle open time, ISO 8601 with a time zone. Defaults to one slice before to.

to
string<date-time>

Exclusive upper bound on candle open time, ISO 8601 with a time zone. Defaults to now.

limit
integer<int32>
default:100

Candles per page. Defaults to 100, maximum 2000.

Required range: 1 <= x <= 2000
side
enum<string>
default:bid

Price side to return. Defaults to bid.

Available options:
bid,
ask,
both
format
enum<string>
default:verbose

compact names each column once; results becomes one array per candle instead of an object.

Available options:
verbose,
compact
cursor
string

Opaque token from pagination.nextCursor.

Response

One page of candles for the requested instrument and interval, newest first unless walking an older slice.

One page of price candles for a single instrument and interval.

instrumentId
integer<int32>
required
symbol
string | null
required

Instrument display name, e.g. AAPL/USD. Null when the page is empty.

interval
enum<string>
required
Available options:
1m,
5m,
10m,
15m,
30m,
1h,
4h,
1d,
1w
side
enum<string>
required
Available options:
bid,
ask,
both
window
object
required

The requested time range, after defaults: [from, to).

pagination
object
required

Keyset pagination metadata for a time-ordered collection. hasNext is always present; nextCursor is opaque and is null exactly when hasNext is false.

results
object[]
required