Skip to main content
Subscribe on an open stream connection. See Connecting to streams for the connection, frames and reconnecting.

​
Filters

​
string
required
The chain slug.
​
string
required
The token’s address.
​
string
default:"1m"
The bucket size: 1s, 5s, 15s, 30s, 1m, 3m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1d or 7d.
​
string
default:"marketCap"
price for price candles, or marketCap for market-cap candles.
​
string
default:"usd"
usd for US dollars, or native for the chain’s native unit.
To follow several timeframes or metrics for one token, open one subscription for each.

​
Update

Each update’s data is the current state of one bucket. A bucket can arrive several times while it is open. Replace the candle that has the same time, and append one with a new time.
​
integer
required
The bucket’s open time, in milliseconds.
​
number
required
The first value in the bucket.
​
number
required
The highest value in the bucket.
​
number
required
The lowest value in the bucket.
​
number
required
The latest value in the bucket.
​
number
required
Traded volume in the bucket, in the subscription’s denomination.
Candle values are JSON numbers, not decimal strings. See the candle exception. To draw history before the stream starts, read candles with the same timeframe, metric and denomination from GET /v1/tokens/{chain}/{address}/ohlcv.

​
Errors