Skip to main content
Stream candles

Authorizations

X-API-KEY
string
header
required
X-API-SECRET
string
header
required

Body

application/json

Streams one market's candles of one price kind at one interval on a venue.

venueId
string
required
priceKind
enum<string>
required

What the venue reports a price to be. Kinds are never relabelled or derived from one another.

Available options:
Traded,
Mark,
Index
interval
enum<string>
required

Candle length. Candles are aligned to whole multiples of it from the Unix epoch, in UTC.

Available options:
Minute1,
Minute3,
Minute5,
Minute15,
Minute30,
Hour1,
Hour2,
Hour4,
Hour6,
Hour12,
Day1
instrument
Future · object
required

An instrument, identified by its fields rather than a venue symbol: type, base, quote, and expiry, strike and right where they apply. type takes the InstrumentType values; unknown types are rejected. Market summaries also give its canonical symbol.

Response

Each item in the stream

One message per line: a Reset first, then Updates, until an Ended line.

One line of the candle stream.

type
enum<string>
required

Always Reset.

Available options:
Reset
timestamp
string<date-time>
required

When Plurex sent the event.

data
object
required

The recent candles, oldest first, ending with the current one.