The identity and technical contract details declared by the specification.
AssetAlertHeartbeats
array
MarketCandle
object
Information about market candle.
10 properties
10 required
MarketLiquidationsDataArray
array
Time series of market liquidations.
GreeksGamma
string
The second derivative of the option's price to the underlying asset's price.
MarketOpenInterestDataArray
array
Time series of market open interest.
TradeAmount
string
The amount of the base asset traded.
PairCandle
object
Information about pair candle.
6 properties
10 required
MiningPoolTipsSummary
object
Information about the mining pool tips summary.
5 properties
5 required
LiquidationPrice
string
The price of the base asset quoted in the quote asset that the liquidation was executed at.
BlockchainBlockHash
string
Hash of the block.
MarketContractPrices
object
Information about market contract prices.
7 properties
3 required
DefiBalanceSheetItemBalanceUsd
string
Balance USD value.
MempoolFeerateBandPhysicalSize
string
Physical sizes summed up for all the transactions included into the current mempool feerate band.
MarketFundingRatesResponse
object
3 properties
1 required
MarketFundingRatesPredictedDataArray
array
Time series of predicted market funding rates.
MempoolFeeratesResponse
object
Mempool feerates response.
3 properties
1 required
DefiBalanceSheetAssetsTotalCount
string
Total count of all assets in the DeFi balance sheet.
Verification
object
Information about verification.
3 properties
1 required
MarketOpenInterestResponse
object
3 properties
1 required
CandleUsdVolume
string
The volume of the candle in USD.
AssetChains
object
Information about the asset chains.
7 properties
5 required
ChainsCount
string
Count of all the chains that were active in the blockchain during the past hour.
BookEntry
object
2 properties
2 required
NextPageUrl
string
URL of the next page results for a given request.
OptionTickerExchangeTime
string
Time corresponding to option ticker data point, according to the exchange. Can be NULL, if exchange doesn't support it.
DefiBalanceSheetLiabilities
array
DeFi balance sheet liabilities.
ExchangePairMetricsResponse
object
Time series of exchange pair metrics.
3 properties
1 required
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…
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.
GreeksRho
string
The first derivative of the option's price to the risk free interest rate.
IndexConstituents
object
Information about index constituents.
3 properties
3 required
ErrorObject
object
2 properties
2 required
AssetAlertValue
string
Captured value of the alerting metric. Omitted if the ratio-based alert's divisor constituent was equal to zero or if the corresponding alert rule consists of…
MempoolFeerateBandConsensusSize
string
Consensus sizes summed up for all the transactions included into the current mempool feerate band. vSizes sum can be derived as 'vSize = consensusSize / 4'.
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…
MarketMetricsResponse
object
Time series of market metrics.
3 properties
1 required
TradeMarkPrice
string
The price representing the futures' or option's price calculated by the exchange for risk management purposes.
FundingRateInterval
string
Interval of a funding rate for a given market.
IndexConstituentPrice
string
The price of the constituent.
MarketTradesDataArray
array
Time series of market trades.
ErrorResponse
object
1 property
1 required
DefiBalanceSheetProtocolUtilizationRatio
string
DeFi balance sheet protocol utilization ratio.
IndexConstituentsResponse
object
3 properties
1 required
Time
string
The time in ISO 8601 date-time format. Always with nanoseconds precision.
DefiProtocol
string
DeFi protocol name (e.g. aavev2eth or uniswapv3eth).
MarketImpliedVolatility
object
Information about market implied volatility.
8 properties
3 required
TradeInitiator
string
Swap transaction initiator. Available for DeFi markets only.
MarketQuote
object
Information about market quote.
7 properties
3 required
DefiBalanceSheetItemShare
string
The percentage that this item represents relative to the total value.
AssetId
string
Unique name of the asset.
CandlePriceHigh
string
The high price of the candle.
MarketLiquidation
object
Information about liquidation.
8 properties
7 required
ImpliedVolatilityTrade
string
Implied volatility calculated from last trade price.
LiquidationAmount
string
The amount of the base asset liquidated.
DefiBalanceSheetBlockHeight
string
The block height at which this DeFi balance sheet is calculated.
ProtocolMetricValue
object
Protocol metric value.
4 properties
4 required
DefiBalanceSheetTvlTotalUsd
string
Total USD value of TVL in the DeFi balance sheet.
CandleVwap
string
The volume-weighted average price of the candle.
IndexId
string
Name of the index.
MarketLiquidationsResponse
object
3 properties
1 required
MempoolFeerateBandFeerate
string
Rounded feerate value used to aggregate the transactions into the current mempool feerate band. Unit is sat/vB.
MarketGreeks
object
Information about market greeks.
9 properties
3 required
OrderBookSize
string
The size of the limit order on the order book in units of the base asset.
IndexLevelsResponse
object
3 properties
1 required
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.
PairCandlesResponse
object
3 properties
1 required
TradeTransactionId
string
Swap transaction ID. Available for DeFi markets only.
MarketGreeksResponse
object
3 properties
1 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.
MiningPoolTipsSummaryResponse
object
3 properties
1 required
Reorg
string
Indicates if the last appended block triggered the chain reorganization.
QuoteAskSize
string
The size of the top ask on the order book. If no asks in the order book, the ask size is skipped.
MempoolFeerateBands
array
Signature
string
The signature information.
DefiBalanceSheetLiabilityItem
object
DeFi balance sheet liability item.
4 properties
2 required
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.
MempoolFeerateBandFees
string
Fees summed up for all the transactions included into the current mempool feerate band. Unit is BTC.
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.
MarketFundingRatesDataArray
array
Time series of market funding rates.
TradeSender
string
Swap caller. Available for DeFi markets only.
BlockHashesAtTip
string
The count of unique hashes at the chain tip.
DefiBalanceSheetsResponse
object
DeFi balance sheets response.
3 properties
1 required
IndexCandlesResponse
object
3 properties
1 required
CandleTradesCount
string
The number of trades used for candle calculation.
Institution
string
Institution name.
DefiBalanceSheetAssetItem
object
DeFi balance sheet asset item.
10 properties
2 required
MarketContractPricesResponse
object
3 properties
1 required
DefiBalanceSheetLiabilitiesTotalCount
string
Total count of all liabilities in the DeFi balance sheet.
DefiBalanceSheetTime
string
The time near or equal to the block creation time this DeFi balance sheet is calculated at. The time in ISO 8601 date-time format. Always with nanoseconds prec…
Asset
string
Name of the asset.
MarketQuotesResponse
object
3 properties
1 required
GreeksVega
string
The first derivative of the option's price to the volatility of the underlying asset's price.
GreeksDelta
string
The first derivative of the option's price to the underlying asset's price.
TradeImpliedVolatility
string
Implied volatility calculated from the trade price.
ReorgDepth
string
A number of consecutive blocks that were disconnected from the common ancestor block of the previous and current longest active chains during the chain reorgan…
AssetAlertHeartbeat
object
4 properties
3 required
ExchangeAsset
string
Unique combination of the exchange and asset.
PairId
string
Unique name of the pair.
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…
IndexConstituentQuantity
string
The quantity of the constituent.
Exchange
string
Name of the exchange.
AssetChainsResponse
object
3 properties
1 required
AssetAlertThreshold
string
Asset alert's Key Risk Indicator threshold value. Omitted if the corresponding alert rule consists of multiple conditions.
DefiBalanceSheetLoansLentTotalUsd
string
Total USD value of loans lent in the DeFi balance sheet.
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.
NextPageToken
string
Token of the next page results for a given request.
MarketCandlesResponse
object
3 properties
1 required
CandleVolume
string
The volume of the candle in units of the base asset.
AssetAlertsResponse
object
Asset alerts response.
4 properties
1 required
IndexCandle
object
Information about index candle.
7 properties
7 required
InstitutionMetricsResponse
object
Time series of institution metrics.
3 properties
1 required
TradeBlockHash
string
Swap block hash. Available for DeFi markets only.
MarketOrderbookResponse
object
3 properties
1 required
AssetChainBlock
object
3 properties
3 required
AssetAlertName
string
Asset alert name.
CandlePriceLow
string
The low price of the candle.
AssetAlertStatus
string
Becomes 'active' if there was a breach of the Key Risk Indicator, otherwise stays 'inactive'.
AssetChain
array
Contains the chain fragments starting from the block which is a common ancestor for other blocks. If there is a single active chain - only the chain tip is inc…
ProtocolMetricsResponse
object
Time series of protocol metrics.
3 properties
1 required
MarketFundingRate
object
Information about funding rate.
6 properties
3 required
DefiBalanceSheetCurrentRatio
string
DeFi balance sheet current ratio.
DefiBalanceSheetLiquidSupplyRatio
string
DeFi balance sheet liquid supply ratio.
FundingRateRate
string
Rate of a funding rate.
PairMetricsResponse
object
Time series of pair metrics.
3 properties
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…
BlocksCountAtTip
string
Count of the blocks on the maximum chain height.
GreeksTheta
string
The first derivative of the option's price to the passage of time.
Market
string
Unique name of the market.
ImpliedVolatilityBid
string
Implied volatility calculated from bid price.
DefiBalanceSheet
object
16 properties
12 required
TradeLiquidation
string
Indicates whether the maker side, taker side, or both sides of the trade is under liquidation.
MempoolFeerateBand
object
5 properties
4 required
IndexLevelValue
string
The value of the index.
DefiBalanceSheetNetWorkingCapitalUsd
string
DeFi balance sheet net working capital USD value.
BlockchainBlockHeight
string
Height of the block.
IndexLevel
object
Information about index level.
4 properties
3 required
MarketId
string
Unique name of the market.
IndexWeight
string
The weight of the constituent.
QuoteBidSize
string
The size of the top bid on the order book. If no bids in the order book, the bid size is skipped.
ExchangePair
string
Unique combination of the exchange and pair.
TipsCount
string
The count of unique elements in the tips array.
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.
DefiBalanceSheetDebtToAssetRatio
string
DeFi balance sheet debt to asset.
MempoolFeerateBandCount
string
Amount of transactions included into the current mempool feerate band.
MarkPrice
string
The price representing the futures' or option's price calculated by the exchange for risk management purposes.
TradeBlockHeight
string
Swap block height. Available for DeFi markets only.
Pair
string
Pair string representation as - .
Index
string
Name of the index.
ImpliedVolatilityMark
string
Implied volatility calculated from mark price.
ImpliedVolatilityAsk
string
Implied volatility calculated from ask price.
AssetMetricsResponse
object
Time series of asset metrics.
3 properties
1 required
ExchangeMetricsResponse
object
Time series of Exchange metrics.
3 properties
1 required
AssetAlert
object
7 properties
4 required
OrderBookAsks
array
The ask orders on the order book.
ContractCount
string
Number of contracts.
OrderBookBids
array
The bids orders on the order book.
ExchangeAssetMetricsResponse
object
Time series of exchange metrics.
3 properties
1 required
MarketImpliedVolatilityResponse
object
3 properties
1 required
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.
MempoolFeerate
object
3 properties
3 required
OpenInterestExchangeTime
string
Time corresponding to open interest data point, according to the exchange. Can be NULL, if exchange doesn't support it.
MarketOpenInterest
object
Information about open interest.
6 properties
5 required
MarketOrderBook
object
Information about order book.
7 properties
6 required
IndexConstituentWeightBasisValue
string
The weight basis value of the constituent.
DefiBalanceSheetAssetsTotalUsd
string
Total USD value of all assets in the DeFi balance sheet.
DefiBalanceSheetItemBalanceUnits
string
Balance units value.
PoolCount
string
The count of unique pools mining on the tip.
MarketFundingRatePredicted
object
Information about predicted funding rate.
5 properties
4 required
DatabaseTime
string
A time when we saved the data in the database. The time is in ISO 8601 date-time format. Always with nanoseconds precision.
FundingRatePredictedEstimatedRate
string
Estimated rate of a predicted funding rate.
MarketFundingRatesPredictedResponse
object
3 properties
1 required
MarketTrade
object
Information about trade.
17 properties
6 required
OrderBookCollectTime
string
Time of when the order book was received from the exchange.
DefiBalanceSheetAssets
array
DeFi balance sheet assets.
MarketTradesResponse
object
3 properties
1 required
DefiBalanceSheetLiabilitiesTotalUsd
string
Total USD value of all liabilities in the DeFi balance sheet.
FundingRatePeriod
string
Period of a funding rate for a given market.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Coin Metrics publishes across the network.