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

# Market orderbooks

`GET /timeseries-stream/market-orderbooks`

Returns a WebSocket stream of orderbooks for specified markets.<br/> Orderbooks are delivered using a sequence of `snapshot` and `update` messages.<br/> Zero value of the `size` response field for `asks` or `bids` means negative `update`.<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
- `depth_limit` string
- `backfill` 'latest' | 'none'
- `pretty` boolean

## Response `default`

Orderbook WebSocket message.

- StreamingMarketOrderbook
  - `market` string, required — Unique name of the market.
  - `time` string, required — The time in ISO 8601 date-time format. Always with nanoseconds precision.
  - `coin_metrics_id` string, required — ID of an order book or quote. It can be generated by Coin Metrics or provided by an exchange. If it is generated by Coin Metrics it is unique. If it is generated by exchange we can't guarantee its uniqueness.
  - `asks` BookEntry[], required — The ask orders on the order book.
    - `price` string, required — The limit price of the order on the order book.
    - `size` string, required — The size of the limit order on the order book in units of the base asset.
  - `bids` BookEntry[], required — The bids orders on the order book.
    - `price` string, required — The limit price of the order on the order book.
    - `size` string, required — The size of the limit order on the order book in units of the base asset.
  - `type` 'snapshot' | 'update', required — Type of the order book.
  - `collect_time` string, required — Time of when the order book was received from the exchange.
  - `cm_sequence_id` string, required — The monotonically increasing message number, resets on disconnection.

---

[API](https://skmtc.net/coinmetrics/apis/coin-metrics-api-v4.md) · [All operations](https://skmtc.net/coinmetrics/apis/coin-metrics-api-v4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/coinmetrics/coin-metrics-api-v4/revisions/774268c0a4fe/schema)