How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coin Metrics Timeseries stream API

WebSocket endpoints for getting a real-time stream of metrics, market data, indexes and other time series data.

Coin Metrics Timeseries stream API is one of 19 APIs that Coin Metrics publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Timeseries stream. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 11 operations across 11 paths, and defines 76 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against 3 base URLs: https://api.coinmetrics.io/v4, wss://api.coinmetrics.io/v4, https://community-api.coinmetrics.io/v4.

11 operations 11 paths 76 schemas 11 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.coinmetrics.io/v4
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Coin Metrics Timeseries stream API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (api_key).

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

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 GET. Each is listed below with its method, path, parameters, and response codes.

Timeseries stream 11

WebSocket endpoints for getting a real-time stream of metrics, market data, indexes and other time series data.

GET
/timeseries-stream/asset-metrics
Asset metrics
getTimeseriesStreamAssetMetrics 7 params → 414default
GET
/timeseries-stream/market-trades
Market trades
getTimeseriesStreamMarketTrades 3 params → 414default
GET
/timeseries-stream/market-liquidations
Market liquidations
getTimeseriesStreamMarketLiquidations 3 params → 414default
GET
/timeseries-stream/market-openinterest
Market open interest
getTimeseriesStreamMarketOpenInterest 3 params → 401403414default
GET
/timeseries-stream/market-contract-prices
Market contract prices
getTimeseriesStreamMarketContractPrices 3 params → 401403414default
GET
/timeseries-stream/market-orderbooks
Market orderbooks
getTimeseriesStreamMarketOrderbooks 4 params → default
GET
/timeseries-stream/market-quotes
Market quotes
getTimeseriesStreamMarketQuotes 4 params → 414default
GET
/timeseries-stream/asset-quotes
Asset quotes
getTimeseriesStreamAssetQuotes 4 params → 414default
GET
/timeseries-stream/pair-quotes
Pair quotes
getTimeseriesStreamPairQuotes 4 params → 414default
GET
/timeseries-stream/market-candles
Market candles
getTimeseriesStreamMarketCandles 4 params → 200401403414
GET
/timeseries-stream/index-levels
Index levels
getTimeseriesStreamIndexLevels 4 params → 200401403414

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are StreamingMarketTrade (18 properties), MarketCandle (10 properties), StreamingMarketLiquidation (8 properties), AggregatedSpreadQuote (8 properties). Each schema is shown below with its type and property counts.

TradeInitiator
string
Swap transaction initiator. Available for DeFi markets only.
StreamingMarketOpenInterest
object
Market open interest WebSocket message.
6 properties 5 required
CandleTradesCount
string
The number of trades used for candle calculation.
MarketQuote
object
Information about market quote.
7 properties 3 required
StreamingMarketQuote
MarketCandle
object
Information about market candle.
10 properties 10 required
QuoteMidPrice
string
The average of the bid price and ask price.
IndexLevel
object
Information about index level.
4 properties 3 required
MarketId
string
Unique name of the market.
TradeAmount
string
The amount of the base asset traded.
Asset
string
Name of the asset.
CandlePriceHigh
string
The high price of the candle.
QuoteBidSize
string
The size of the top bid on the order book. If no bids in the order book, the bid size is skipped.
LiquidationPrice
string
The price of the base asset quoted in the quote asset that the liquidation was executed at.
LiquidationAmount
string
The amount of the base asset liquidated.
StreamingAssetMetric
object
Metric values.
3 properties 3 required
CandleVwap
string
The volume-weighted average price of the candle.
TradePrice
string
The price of the base asset quoted in the quote asset that the trade was executed at.
CandlePriceOpen
string
The opening price of the candle.
TradeImpliedVolatility
string
Implied volatility calculated from the trade price.
MarkPrice
string
The price representing the futures' or option's price calculated by the exchange for risk management purposes.
OrderBookType
string
Type of the order book.
StreamingMarketCandle
Pair
string
Pair string representation as - .
TradeBlockHeight
string
Swap block height. Available for DeFi markets only.
Index
string
Name of the index.
StreamingAggregatedSpreadQuote
OrderBookAndQuoteCoinMetricsId
string
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 generat…
Verification
object
Information about verification.
3 properties 1 required
OrderBookSize
string
The size of the limit order on the order book in units of the base asset.
QuoteBidPrice
string
The limit price of the top bid on the order book. If no bids in the order book, the bid price is skipped.
StreamingMarketTrade
object
Market trade WebSocket message.
18 properties 7 required
TradeCollectTime
string
Time of when the trade was received from the exchange.
OrderBookAsks
array
The ask orders on the order book.
ContractCount
string
Number of contracts.
TradeIndexPrice
string
The price index is an aggregate price derived from the major exchanges to be representative of the underlying asset's market consensus price.
OrderBookBids
array
The bids orders on the order book.
CandleUsdVolume
string
The volume of the candle in USD.
TradeTransactionId
string
Swap transaction ID. Available for DeFi markets only.
CandleVolume
string
The volume of the candle in units of the base asset.
AggregatedSpreadQuote
object
Information about aggregated spread quote.
8 properties 2 required
BookEntry
object
2 properties 2 required
QuoteAskPrice
string
The limit price of the top ask on the order book. If no asks in the order book, the ask price is skipped.
LiquidationType
string
The liquidation type. "trade" means that liquidation was executed, "order" means that the order was placed for the liquidation at the timestamp of the data ent…
SettlementPriceEstimated
string
The estimated price of the underlying asset.
TradeBlockHash
string
Swap block hash. Available for DeFi markets only.
OpenInterestExchangeTime
string
Time corresponding to open interest data point, according to the exchange. Can be NULL, if exchange doesn't support it.
QuoteAskSize
string
The size of the top ask on the order book. If no asks in the order book, the ask size is skipped.
StreamingIndexLevel
OptionTickerExchangeTime
string
Time corresponding to option ticker data point, according to the exchange. Can be NULL, if exchange doesn't support it.
TradeSide
string
The market order side. "buy" means that an ask was removed from the book by an incoming buy order, "sell" means that a bid was removed from the book by an inco…
StreamingMarketLiquidation
object
Market liquidation WebSocket message.
8 properties 7 required
IndexPrice
string
The price index is an aggregate price derived from the major exchanges to be representative of the underlying asset's market consensus price.
OrderBookPrice
string
The limit price of the order on the order book.
StreamingMarketContractPrice
object
Market contract price WebSocket message.
7 properties 3 required
Signature
string
The signature information.
cmSequenceId
string
The monotonically increasing message number, resets on disconnection.
ErrorObject
object
2 properties 2 required
CandlePriceLow
string
The low price of the candle.
CandlePriceClose
string
The closing price of the candle.
TradesCoinMetricsId
string
ID of a trade (unique per exchange market). We are using exchange reported value if exchange reports a unique numeric trade id. If exchange reports trade id as…
QuoteSpread
string
The difference between the bid price and ask price as a percentage of the mid price.
TradeMarkPrice
string
The price representing the futures' or option's price calculated by the exchange for risk management purposes.
LiquidationsCoinMetricsId
string
ID of a liquidation (unique per exchange market). We are using exchange reported value if exchange reports a unique numeric liquidation id. If exchange reports…
VerificationTime
string
The verification time of the index.
OrderBookCollectTime
string
Time of when the order book was received from the exchange.
ErrorResponse
object
1 property 1 required
LiquidationSide
string
The market order side. "buy" means that an ask was removed from the book by an incoming buy order, "sell" means that a bid was removed from the book by an inco…
ContractValueUSD
string
Deprecated. Contract value in USD. This field was previously calculated using hardcoded logic that no longer reflects current contract specifications across al…
TradeBeneficiary
string
Swap output receiver. Available for DeFi markets only.
VerificationIndexLevelValue
string
The verification value of the index.
StreamingMarketOrderbook
Time
string
The time in ISO 8601 date-time format. Always with nanoseconds precision.
TradeSender
string
Swap caller. Available for DeFi markets only.
TradeLiquidation
string
Indicates whether the maker side, taker side, or both sides of the trade is under liquidation.
IndexLevelValue
string
The value of the index.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coin-metrics-timeseries-stream-api-openapi.yml Raw ↑

Other APIs Coin Metrics publishes across the network.

Coin Metrics Blockchain Explorer Job API
Coin Metrics Blockchain Metadata API
Coin Metrics Catalog API
Coin Metrics Catalog v2 API
Coin Metrics Chain Monitor tools API
Coin Metrics Constituent Snapshots API
Coin Metrics Constituent Timeframes API
Coin Metrics Full blockchain entities v2 API
Coin Metrics Full catalog API
Coin Metrics Full catalog v2 API
Coin Metrics Jobs API
Coin Metrics List of blockchain entities v2 API
Where this information came from

This is an independent, third-party profile of Coin Metrics Timeseries stream API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.