Data Encyclopedia
HomeCharts
  • Welcome & Product Overview
  • Getting Started
  • Tutorials and Examples
    • Tutorials
      • Python API Client Walkthrough
      • Getting Started With Market Data
      • Getting Started With Futures Data
      • Aggregating Options Data
      • Examining Orderbook Depth
      • Aggregating Orderbook Depth to Create Liquidity Metrics
      • Comparing Stablecoin Prices Using Different Pricing Methods
      • Comparing Volumes of Exchanges and Assets
      • Creating Custom Network Data Metrics Using ATLAS
      • Applying Different Types of Marketcap Metrics
      • Comparing the Dominance of Mining Pools Using ATLAS
      • Using Staking Metrics to Get Yield and Staked Supply
      • Granular Insights On Chain Using Hourly Network Data Metrics
      • Exploring Options, Open Interest, and Volatility Data
      • Calculating Total Value Locked in Liquidity Pools using DEX Data
      • Calculating DEX Liquidity Pool Fees and Volumes
      • Analyzing DeFi Protocol Balance Sheets
    • How To Guides
      • How To Export Data
      • How To Migrate From Catalog to Catalog V2 and Reference Data
      • How To Use the Coin Metrics API Efficiently
    • Dashboard Examples
  • Packages
    • CM Labs
    • Coin Metrics Community Data
  • Access Our Data
    • API Reference
    • API Conventions
      • Catalog V1 to Catalog V2 Migration
    • Python API Client
    • R API Client
    • Coverage
    • Status Page
  • Data Visualization
    • Charting Tool
      • Formula Builder
      • Correlation Tool
      • Embedded Charts
      • Troubleshooting
    • Dashboard
      • Troubleshooting
    • CMTV Charts (Labs)
      • Troubleshooting
    • Atlas Explorer
  • Network Data
    • Network Data Pro Overview
      • Availability
        • Asset Completion Time
      • Addresses
        • Active Addresses
        • Address Balances
        • New Addresses
      • Economics
        • Mining
        • Valuation
      • Exchange
        • Deposits
        • Exchange Supply
        • Net Flows
        • Transaction Count
        • Withdrawals
      • Fees and Revenue
        • Fees
        • Revenue
      • Market
        • Market Capitalization
        • Price
        • Profitability
        • Returns
        • Volatility
      • Key Risk Indicator (KRI) Feed
        • Blocks
        • Block Attributes
        • Block Size
        • Block Times
        • Empty Blocks
        • Fees
        • Outputs
        • Rewards
        • Feerates
        • Hashrate
        • Transaction Feerates
        • Transaction Fees
        • Transaction Sizes
        • Transactions
      • Mining
        • Balances
        • Difficulty
        • Exchange Flows
        • Flows
        • Hardware Hash Rate
        • Hash Rate
      • Network Usage
        • Blocks
        • Contracts
        • Profitability
        • UTXOs
        • Blobs
      • Staking
        • Consensus Health
        • Flows
        • Penalty Metrics
        • Slashing Metrics
        • Validator Supply
        • Stakers
        • Yield
      • Supply
        • Active Supply
        • Addresses with Balance
        • Burnt Supply
        • Current Supply
        • Free Float Supply
        • Future Expected Supply
        • Miner Revenue
        • Profitability
        • Revived Supply
        • Shielded Supply
        • Supply Issuance
        • Staking Supply
      • Transactions
        • Blobs
        • Contracts
        • Token Transactions
        • Transactions
        • Transfer Value
        • Transfers
        • Velocity
      • Wallets
        • Active Wallets
        • Wallet Balances
    • Atlas Overview
      • Accounts
      • Account Balance
      • Blocks
        • Full Block
      • Transactions
        • Full Transaction
          • Full Transaction Info for Block
      • Balance Updates
    • Methodologies
      • Normalizing Block Times
    • DeFi Overview
      • Decentralized Exchange Data
      • DeFi Balance Sheets
      • DeFi FAQs
    • Tagging Meta Data
    • Transaction Tracker
    • CM Labs
      • Mining Pool Monitor Overview
        • Mining Pool Monitor API Fields
      • Reorg & Fork Tracker Overview
        • Reorg & Fork Tracker Tracker API Fields
    • Deprecated
      • Mempool Monitor
      • WatchTower Alerts Overview - DEPRECATED
        • WatchTower Alerts - DEPRECATED
          • Ethereum Proof-of-Stake Alerts - DEPRECATED
            • Missed Slot Alert - DEPRECATED
            • Fast Increase in Transaction Count Alert - DEPRECATED
            • Fast Decrease in Transaction Count Alert - DEPRECATED
            • Fast Decrease in Base Fees - DEPRECATED
            • Fast Increase in Base Fees - DEPRECATED
            • Fast Decrease in Priority Fees (Tips) Alert - DEPRECATED
            • Fast Increase in Priority Fees (Tips) Alert - DEPRECATED
            • Decrease in Active Addresses Alert - DEPRECATED
            • Increase in Active Addresses Alert - DEPRECATED
            • Decrease in Total Block Fees Alert - DEPRECATED
            • Increase in Total Block Fees Alert - DEPRECATED
          • DeFi Alerts - DEPRECATED
            • Smart Contract Admin Change Alert - DEPRECATED
            • Admin Change with Issuance Event Alert - DEPRECATED
            • Admin Change with Large Issuance Event Alert - DEPRECATED
          • Mining Alerts - DEPRECATED
            • Unknown Miner Predominance Alert - DEPRECATED
            • Mining Pool Conflict Alert - DEPRECATED
            • Persistent Mining Pool Conflict Alert - DEPRECATED
            • Hashrate Decrease Alert - DEPRECATED
            • 1-Block Difficulty Decrease - DEPRECATED
          • Blockchain Alerts - DEPRECATED
            • 1 Block Reorg Alert - DEPRECATED
            • 2 Block Reorg Alert - DEPRECATED
            • 3 Block Reorg Alert - DEPRECATED
            • Satoshi Coins Spent - DEPRECATED
            • Vintage Coins Spent - DEPRECATED
            • Slow Block Alert - DEPRECATED
            • 1 Consecutive Empty Block Alert - DEPRECATED
            • 2 Consecutive Empty Blocks Alert - DEPRECATED
            • 3 Consecutive Empty Blocks Alert - DEPRECATED
            • 6 Consecutive Empty Blocks Alert - DEPRECATED
          • Mempool Alerts - DEPRECATED
            • Mempool Disruption Alert - DEPRECATED
            • Mempool Size 90% Alert - DEPRECATED
            • Mempool Size 95% Alert - DEPRECATED
            • Mempool Size 99% Alert - DEPRECATED
            • Mempool Size 100% Alert - DEPRECATED
            • Mempool Congestion Alert - DEPRECATED
        • WatchTower API Fields - DEPRECATED
    • Network Data Glossary
    • Network Data FAQs
  • Market Data
    • Market Data Overview
      • Basis
      • Candles
      • Contract Prices
      • Funding Rates
        • Funding Rates
        • Predicted Funding Rates
        • Aggregated Futures Funding Rate
        • Cumulative Futures Funding Rate
      • Greeks
      • Institution Metrics
        • Grayscale
          • Shares Outstanding
          • Market Price
          • Net Asset Value
          • Coin Per Share
          • Total Assets
      • Liquidations
        • Market Level Liquidations
        • Liquidation Metrics
      • Liquidity
        • Bid-Ask Spread Percent
        • Order Book Depth
        • Slippage
      • Market Metadata
      • Open Interest
        • Market Level Open Interest
        • Reported Open Interest
      • Orderbooks
      • Quotes
      • Trades
      • Volatility
        • Market Implied Volatility
        • Implied Volatility
        • Realized Volatility
      • Volume
        • Trusted Volume
        • Reported Volume
    • CM Prices
      • Reference Rate
      • Principal Market Price (USD)
      • Principal Market (USD)
    • Methodologies
      • Coin Metrics Prices Policies
      • Coin Metrics Prices Methodology
      • Trusted Exchange Framework
    • Market Data FAQs
      • CM Prices FAQs
      • Trusted Exchange Framework FAQs
  • Index Data
    • Index Overview
      • Index Timeseries
        • Index Levels
        • Index Candles
        • Index Constituents
    • Policies & Charters
      • CMBI Index Policies
      • Governance Committees
    • Methodologies
      • Fork Legitimacy Framework
      • Adjusted Free Float Supply Methodology
      • Candidate Market Guidelines
    • Fact Sheets
      • CMBI Single Asset Series Fact Sheet
      • CMBI Multi Asset Series Fact Sheet
      • CMBI Total Market Series Fact Sheet
      • CMBI Mining Series Fact Sheet
    • Indexes Glossary
    • Index FAQs
  • Reference Data
    • datonomy Overview
      • Taxonomy for Assets
      • Taxonomy Metadata for Assets
      • datonomy FAQs
    • Profiles Overview
      • Asset Profiles
      • Network Profiles
    • Security Master Overview
      • Assets
      • Markets
    • Methodologies
      • Guiding Principles and Methodology for datonomy
  • BITTENSOR
    • Precog Methodology
      • Point Forecast Ranking
      • Interval Forecast Ranking
      • Interval Score Examples
      • Miner Weight from Rank
Powered by GitBook
On this page

Was this helpful?

  1. Market Data
  2. Market Data Overview
  3. Liquidity

Order Book Depth

Definition

Liquidity depth metrics measure the available order book liquidity at different percentage levels from the midprice. These metrics provide measure the market depth and assess how much volume is available for trading at different price levels. The metrics are computed in both the native units of the base asset for spot markets and in contract values for futures markets, and their equivalent value in USD.

Name
MetricID
Unit
Interval

Order Book Depth, 0.1 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 0.2 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.3 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.4 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.5 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.6 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.7 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.8 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 0.9 Percent From Midprice, Ask, Native Units

Native Unit

1h

Order Book Depth, 1 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 1.5 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 2 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 3 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 4 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 5 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 6 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 7 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 8 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 9 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 10 Percent From Midprice, Ask, Native Units

Native Units

1h

Order Book Depth, 0.1 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.2 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.3 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.4 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.5 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.6 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.7 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.8 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.9 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 1 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 1.5 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 2 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 3 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 4 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 5 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 6 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 7 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 8 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 9 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 10 Percent From Midprice, Ask, USD

USD

1h

Order Book Depth, 0.1 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.2 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.3 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.4 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.5 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.6 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.7 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.8 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.9 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 1 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 1.5 Percent From Midprice, Bid, Native Units

Native Unit

1h

Order Book Depth, 2 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 3 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 4 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 5 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 6 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 7 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 8 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 9 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 10 Percent From Midprice, Bid, Native Units

Native Units

1h

Order Book Depth, 0.1 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.2 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.3 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.4 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.5 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.6 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.7 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.8 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 0.9 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 1 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 1.5 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 2 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 3 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 4 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 5 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 6 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 7 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 8 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 9 Percent From Midprice, Bid, USD

USD

1h

Order Book Depth, 10 Percent From Midprice, Bid, USD

USD

1h

Details

The liquidity depth metrics follow a structured naming convention:

  • liquidity_depth_{X}_percent_ask_volume_units: Order book depth on the ask side at X% of midprice in base asset units.

  • liquidity_depth_{X}_percent_bid_volume_units: Order book depth on the bid side at X% of midprice in base asset units.

  • liquidity_depth_{X}_percent_ask_volume_usd: Order book depth on the ask side at X% of midprice converted to USD.

  • liquidity_depth_{X}_percent_bid_volume_usd: Order book depth on the bid side at X% of midprice converted to USD.

Each liquidity depth metric represents the cumulative volume available on either the bid or ask side of the order book at a specified percentage away from the midprice.

The midprice is defined as the average of the best bid and best ask prices:

The total volume available on the order book at or within X% of the midprice, expressed in the base asset’s native units for spot markets and contract units for futures markets:

The total volume available on the order book at or within X% of the midprice, expressed in U.S. dollars for spot markets:

Futures markets follow a modified formula that takes into account the contract size:

API Endpoints

Liquidity order book depth metrics can be accessed using the following endpoints:

  • timeseries/market-metrics

curl --compressed "https://api.coinmetrics.io/v4/timeseries/market-metrics?markets=coinbase-btc-usd-spot&metrics=liquidity_depth_2_percent_ask_volume_units&frequency=1h&limit_per_market=1&api_key=<your_key>"
import requests
response = requests.get('https://api.coinmetrics.io/v4/timeseries/market-metrics?markets=coinbase-btc-usd-spot&metrics=liquidity_depth_2_percent_ask_volume_units&frequency=1h&limit_per_market=1&api_key=<your_key>').json()
print(response)
from coinmetrics.api_client import CoinMetricsClient

api_key = "<API_KEY>"
client = CoinMetricsClient(api_key)

print(
    client.get_market_metrics(
        markets=["coinbase-btc-usd-spot"], metrics=['liquidity_depth_2_percent_ask_volume_units'], frequency='1h', limit_per_market=1
    ).to_dataframe()
)

Examples

A sample of the Order Book Depth, 2 Percent From Midprice, Ask, Native Units for the Coinbase BTC-USD spot market is shown below:

{
  "data" : [ {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T20:00:00.000000000Z",
    "liquidity_depth_2_percent_ask_volume_units" : "9866859.984315595"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T21:00:00.000000000Z",
    "liquidity_depth_2_percent_ask_volume_units" : "10170729.085314134"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T22:00:00.000000000Z",
    "liquidity_depth_2_percent_ask_volume_units" : "10909944.294472648"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T23:00:00.000000000Z",
    "liquidity_depth_2_percent_ask_volume_units" : "10983104.902848331"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-05T00:00:00.000000000Z",
    "liquidity_depth_2_percent_ask_volume_units" : "11103789.859471431"
  } ]
}
  • market: The id of the markets.

  • time: The time in ISO 8601 date-time format.

  • liquidity_depth_2_percent_bid_volume_usd: The sum of all bid orders with price within 2 percent from midprice in native units.

Frequently Asked Questions

Why are some of the values for some order book depth metrics and observations missing?

Coin Metrics calculates order book depth metrics from order book snapshots obtained from centralized exchanges. Coin Metrics will obtain the deepest and most complete order book snapshot that the exchange offers — however, the order book depth allowed varies by exchange.

If the order book depth for a market is insufficient to calculate a particular order book depth metric at X% from midprice, Coin Metrics will assign a null value to the observation. The null value was chosen instead of using the available depth to calculate a value (even if the order book depth is insufficient to calculate a value at X% from midprice) to provide transparecy to the user that the order book depth is too shallow. If a non-null value is desired, it is recommended to select a metric with a smaller X% from midprice.

How often are the metrics calculated?

The depth metrics are calculated once an hour.

Release History

  • Release Version. Market Data Feed v2.8 on May 2023.

PreviousBid-Ask Spread PercentNextSlippage

Last updated 2 months ago

Was this helpful?

Midprice=Best Bid Price+Best Ask Price2 \text{Midprice} = \frac{\text{Best Bid Price} + \text{Best Ask Price}}{2}Midprice=2Best Bid Price+Best Ask Price​

Liquidity DepthX%=∑p≥Pmid(1−X%)Vbid(p)(for bids) \text{Liquidity Depth}_{X\%} = \sum_{p \geq P_{\text{mid}} (1 - X\%)} V_{\text{bid}}(p) \quad \text{(for bids)}Liquidity DepthX%​=∑p≥Pmid​(1−X%)​Vbid​(p)(for bids)

Liquidity DepthX%=∑p≤Pmid×(1+X%)Vask(p)(for asks) \text{Liquidity Depth}_{X\%} = \sum_{p \leq P_{\text{mid}} \times (1 + X\%)} V_{\text{ask}}(p) \quad \text{(for asks)}Liquidity DepthX%​=∑p≤Pmid​×(1+X%)​Vask​(p)(for asks)

Liquidity DepthX%,USD=∑p≥Pmid×(1−X%)Vbid(p)×Pbid(for bids) \text{Liquidity Depth}_{X\%, USD} = \sum_{p \geq P_{\text{mid}} \times (1 - X\%)} V_{\text{bid}}(p) \times P_{\text{bid}} \quad \text{(for bids)}Liquidity DepthX%,USD​=∑p≥Pmid​×(1−X%)​Vbid​(p)×Pbid​(for bids)

Liquidity DepthX%,USD=∑p≤Pmid×(1+X%)Vask(p)×Pask(for asks) \text{Liquidity Depth}_{X\%, USD} = \sum_{p \leq P_{\text{mid}} \times (1 + X\%)} V_{\text{ask}}(p) \times P_{\text{ask}} \quad \text{(for asks)}Liquidity DepthX%,USD​=∑p≤Pmid​×(1+X%)​Vask​(p)×Pask​(for asks)

Liquidity DepthX%,USD=∑p≥Pmid×(1−X%)Vbid(p)×Contract Size×PContractSizeAsset,USD(for bids) \text{Liquidity Depth}_{X\%, USD} = \sum_{p \geq P_{\text{mid}} \times (1 - X\%)} V_{\text{bid}}(p) \times \text{Contract Size} \times P_{\text{ContractSizeAsset,USD}} \quad \text{(for bids)}Liquidity DepthX%,USD​=∑p≥Pmid​×(1−X%)​Vbid​(p)×Contract Size×PContractSizeAsset,USD​(for bids)

Liquidity DepthX%,USD=∑p≥Pmid×(1+X%)Vask(p)×Contract Size×PContractSizeAsset,USD(for asks) \text{Liquidity Depth}_{X\%, USD} = \sum_{p \geq P_{\text{mid}} \times (1 + X\%)} V_{\text{ask}}(p) \times \text{Contract Size} \times P_{\text{ContractSizeAsset,USD}} \quad \text{(for asks)}Liquidity DepthX%,USD​=∑p≥Pmid​×(1+X%)​Vask​(p)×Contract Size×PContractSizeAsset,USD​(for asks)

For more information on the available order book depth by exchange, please see Please note that some exchanges only provide an order book with very shallow depth, such as the top 100 levels. Therefore, a large number of nulls can be expected from markets from these exchanges.

Are there any limitations to the order book depth provided by each exchange?
liquidity_depth_0_1_percent_ask_volume_units
liquidity_depth_0_2_percent_ask_volume_units
liquidity_depth_0_3_percent_ask_volume_units
liquidity_depth_0_4_percent_ask_volume_units
liquidity_depth_0_5_percent_ask_volume_units
liquidity_depth_0_6_percent_ask_volume_units
liquidity_depth_0_7_percent_ask_volume_units
liquidity_depth_0_8_percent_ask_volume_units
liquidity_depth_0_9_percent_ask_volume_units
liquidity_depth_1_percent_ask_volume_units
liquidity_depth_1_5_percent_ask_volume_units
liquidity_depth_2_percent_ask_volume_units
liquidity_depth_3_percent_ask_volume_units
liquidity_depth_4_percent_ask_volume_units
liquidity_depth_5_percent_ask_volume_units
liquidity_depth_6_percent_ask_volume_units
liquidity_depth_7_percent_ask_volume_units
liquidity_depth_8_percent_ask_volume_units
liquidity_depth_9_percent_ask_volume_units
liquidity_depth_10_percent_ask_volume_units
liquidity_depth_0_1_percent_ask_volume_usd
liquidity_depth_0_2_percent_ask_volume_usd
liquidity_depth_0_3_percent_ask_volume_usd
liquidity_depth_0_4_percent_ask_volume_usd
liquidity_depth_0_5_percent_ask_volume_usd
liquidity_depth_0_6_percent_ask_volume_usd
liquidity_depth_0_7_percent_ask_volume_usd
liquidity_depth_0_8_percent_ask_volume_usd
liquidity_depth_0_9_percent_ask_volume_usd
liquidity_depth_1_percent_ask_volume_usd
liquidity_depth_1_5_percent_ask_volume_usd
liquidity_depth_2_percent_ask_volume_usd
liquidity_depth_3_percent_ask_volume_usd
liquidity_depth_4_percent_ask_volume_usd
liquidity_depth_5_percent_ask_volume_usd
liquidity_depth_6_percent_ask_volume_usd
liquidity_depth_7_percent_ask_volume_usd
liquidity_depth_8_percent_ask_volume_usd
liquidity_depth_9_percent_ask_volume_usd
liquidity_depth_10_percent_ask_volume_usd
liquidity_depth_0_1_percent_bid_volume_units
liquidity_depth_0_2_percent_bid_volume_units
liquidity_depth_0_3_percent_bid_volume_units
liquidity_depth_0_4_percent_bid_volume_units
liquidity_depth_0_5_percent_bid_volume_units
liquidity_depth_0_6_percent_bid_volume_units
liquidity_depth_0_7_percent_bid_volume_units
liquidity_depth_0_8_percent_bid_volume_units
liquidity_depth_0_9_percent_bid_volume_units
liquidity_depth_1_percent_bid_volume_units
liquidity_depth_1_5_percent_bid_volume_units
liquidity_depth_2_percent_bid_volume_units
liquidity_depth_3_percent_bid_volume_units
liquidity_depth_4_percent_bid_volume_units
liquidity_depth_5_percent_bid_volume_units
liquidity_depth_6_percent_bid_volume_units
liquidity_depth_7_percent_bid_volume_units
liquidity_depth_8_percent_bid_volume_units
liquidity_depth_9_percent_bid_volume_units
liquidity_depth_10_percent_bid_volume_units
liquidity_depth_0_1_percent_bid_volume_usd
liquidity_depth_0_2_percent_bid_volume_usd
liquidity_depth_0_3_percent_bid_volume_usd
liquidity_depth_0_4_percent_bid_volume_usd
liquidity_depth_0_5_percent_bid_volume_usd
liquidity_depth_0_6_percent_bid_volume_usd
liquidity_depth_0_7_percent_bid_volume_usd
liquidity_depth_0_8_percent_bid_volume_usd
liquidity_depth_0_9_percent_bid_volume_usd
liquidity_depth_1_percent_bid_volume_usd
liquidity_depth_1_5_percent_bid_volume_usd
liquidity_depth_2_percent_bid_volume_usd
liquidity_depth_3_percent_bid_volume_usd
liquidity_depth_4_percent_bid_volume_usd
liquidity_depth_5_percent_bid_volume_usd
liquidity_depth_6_percent_bid_volume_usd
liquidity_depth_7_percent_bid_volume_usd
liquidity_depth_8_percent_bid_volume_usd
liquidity_depth_9_percent_bid_volume_usd
liquidity_depth_10_percent_bid_volume_usd

Market metrics

get

Returns metrics for specified markets. Results are ordered by tuple (market, time). To fetch the next page of results use next_page_url JSON response field.

Authorizations
Query parameters
marketsstring[]Required

Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future. Use the /catalog-all/markets endpoint for the full list of supported markets.

metricsstring[]Required

Comma separated metrics to request time series data for. Use the /catalog-all/market-metrics endpoint for the full list of supported metrics per exchange-asset combination.

Example: ["liquidations_reported_future_buy_units_1d","liquidations_reported_future_sell_units_1d"]
frequencystringOptional

Frequency of the market metrics. Supported values are 1m, 5m, 1h, 1d.

Default: 1d
start_timestringOptional

Start of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If start_time is omitted, response will include time series from the earliest time available.

end_timestringOptional

End of the time interval. This field refers to the time field in the response. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789Z, 2006-01-20, 20060120. Inclusive by default. UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it. If end_time is omitted, response will include time series up to the latest time available.

start_inclusivebooleanOptional

Inclusive or exclusive corresponding start_* parameters.

Default: true
end_inclusivebooleanOptional

Inclusive or exclusive corresponding end_* parameters.

Default: true
timezonestringOptional

Timezone name for start_time and end_time timestamps. This parameter does not modify the output times, which are always UTC. Format is defined by TZ database.

Default: UTCExample: America/New_York
page_sizeinteger · int32 · min: 1 · max: 10000Optional

Number of items per single page of results. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: 100
paging_fromstring · enumOptional

Where does the first page start, at the start of the interval or at the end. The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

Default: endPossible values:
sortstring · enumOptional

How results will be sorted. Metrics are sorted by (market, time) by default. If you want to sort 1d metrics by (time, market) you should choose time as value for the sort parameter. Sorting by time is useful if you request metrics for a set of markets.

Default: marketPossible values:
limit_per_marketinteger · int32Optional

How many entries per market result should contain. It is useful when multiple markets are requested.

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false
formatstring · enumOptional

Format of the response.

Default: jsonPossible values:
next_page_tokenstringOptional

Token for receiving the results from the next page of a query. Should not be used directly. To iterate through pages just use next_page_url response field.

Responses
200
Time series of market metrics.
application/json
400
Market not found.
application/json
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
GET /v4/timeseries/market-metrics HTTP/1.1
Host: api.coinmetrics.io
Accept: */*
{
  "data": [
    {
      "market": "binance-BTCUSDT-future",
      "time": "2022-01-19T20:00:00.000000000Z",
      "liquidations_reported_future_buy_usd_5m": "1298.36866"
    },
    {
      "market": "binance-BTCUSDT-future",
      "time": "2022-01-19T20:10:00.000000000Z",
      "liquidations_reported_future_buy_usd_5m": "39713.60016"
    },
    {
      "market": "binance-BTCUSDT-future",
      "time": "2022-01-19T20:30:00.000000000Z",
      "liquidations_reported_future_buy_usd_5m": "29084.10932"
    },
    {
      "market": "binance-BTCUSDT-future",
      "time": "2022-01-19T21:00:00.000000000Z",
      "liquidations_reported_future_buy_usd_5m": "46294.99528"
    }
  ]
}
  • Definition
  • Details
  • API Endpoints
  • GETMarket metrics
  • Examples
  • Frequently Asked Questions
  • Why are some of the values for some order book depth metrics and observations missing?
  • How often are the metrics calculated?
  • Release History