Market candles

Returns a stream of candles for specified markets. If you are falling behind (slow client) you will get warning message first, then error message and disconnection will happen.

get

Authorizations

api_key

api_keystringRequired

Coin Metrics API key can be specified as ?api_key= query parameter.

Query parameters

marketsstring[]Required

Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
Use a corresponding /catalog-all-v2/market-{dataType} endpoint for the full list of supported markets for a given data type.

frequencystringOptional

Candle duration. Supported values are 1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d.

Default: 1mExample: 1m

backfillstring · enumOptional

What data should be sent upon a connection.
By default the latest values are sent just before real-time data.

Default: latestPossible values:

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

Responses

200

Candle WebSocket message.

application/json

Information about market candle.

marketstringRequired

Unique name of the market.

timestring · date-timeRequired

The time in ISO 8601 date-time format. Always with nanoseconds precision.

price_openstring · decimalRequired

The opening price of the candle.

price_closestring · decimalRequired

The closing price of the candle.

price_highstring · decimalRequired

The high price of the candle.

price_lowstring · decimalRequired

The low price of the candle.

vwapstring · decimalRequired

The volume-weighted average price of the candle.

volumestring · decimalRequired

The volume of the candle in units of the base asset.

candle_usd_volumestring · decimalRequired

The volume of the candle in USD.

candle_trades_countstring · int64Required

The number of trades used for candle calculation.

cm_sequence_idstringRequired

The monotonically increasing message number, resets on disconnection.

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

414

Provided URI is too long. It must not be greater than 10000 symbols.

get/timeseries-stream/market-candles

JavaScriptPython

ws = new WebSocket("wss://api.coinmetrics.io/v4/timeseries-stream/market-candles?markets=bitstamp-btc-usd-spot&pretty=true&api_key=<your_key>")
ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")

{
  "market": "bitstamp-btc-usd-spot",
  "time": "2022-05-17T09:00:00.000000000Z",
  "price_open": 30547.68,
  "price_close": 30558.65,
  "price_high": 30563.59,
  "price_low": 30547.68,
  "vwap": 30553.973252816508,
  "volume": 1.908,
  "candle_usd_volume": 58296.9809663739,
  "candle_trades_count": 10,
  "cm_sequence_id": 0
}