Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

candle

Streams the open candle for one instrument and interval. This channel is served by the API service at /api-ws, not the node /ws endpoint.

Channelcandleserver → client · type candle

Keep the last bar of a chart live after seeding it with candleSnapshot.

Snapshot
infocandleSnapshot
Not this?
Subscribe
{
  "method": "subscribe",
  "subscription": {
    "type": "candle",
    "coin": "19127212",
    "interval": "1m"
  }
}
Try it
WS wss://rpc.txflow-testnet.xyz/api-ws
Subscription parameters
coinstringrequired
intervalstringrequired
typestringrequired
"candle"
Server message
channelstring
"candle"
dataobject
cnumber
hnumber
istring
lnumber
onumber
sstring
tinteger · int64

Bar open time in milliseconds.

vnumber
ninteger
Tinteger · int64

Bar close time in milliseconds.

Message example
{
  "channel": "candle",
  "data": {
    "t": 0,
    "T": 0,
    "s": "19127212",
    "i": "1m",
    "o": 0.52,
    "h": 0.56,
    "l": 0.51,
    "c": 0.55,
    "v": 120,
    "n": 8
  }
}

Seed the chart with candleSnapshot, then replace the current bucket whenever another frame with the same t arrives.

For an Outcome instrument, pass its numeric instrument_id as coin. OHLC values are YES prices/probabilities in [0, 1]; a NO chart uses their complement.