---
title: "Market candles"
method: GET
path: "/timeseries-stream/market-candles"
tags: ["Timeseries stream"]
---

# Market candles

`GET /timeseries-stream/market-candles`

## Request

- Base URL: `wss://api.coinmetrics.io/v4`
- URL: `wss://api.coinmetrics.io/v4/timeseries-stream/market-candles`
- Auth: API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/docs/timeseries-stream/market-candles/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `markets` string[], required
- `frequency` string
- `backfill` 'latest' | 'none'
- `pretty` boolean

## Response `200`

Candle WebSocket message.

- StreamingMarketCandle: Information about market candle.
  - `market` string, required: Unique name of the market.
  - `time` string, required: The time in ISO 8601 date-time format. Always with nanoseconds precision.
  - `price_open` string, required: The opening price of the candle.
  - `price_close` string, required: The closing price of the candle.
  - `price_high` string, required: The high price of the candle.
  - `price_low` string, required: The low price of the candle.
  - `vwap` string, required: The volume-weighted average price of the candle.
  - `volume` string, required: The volume of the candle in units of the base asset.
  - `candle_usd_volume` string, required: The volume of the candle in USD.
  - `candle_trades_count` string, required: The number of trades used for candle calculation.
  - `cm_sequence_id` string, required: The monotonically increasing message number, resets on disconnection.

## Other responses

- `401`: Requested resource requires authorization.
- `403`: Requested resource is not available with supplied credentials.
- `414`: Provided URI is too long. It must not be greater than 10000 symbols.

---

[API](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4.md) - [All operations](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/revisions/774268c0a4fe?raw)