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

Slippage

Definition

Slippage refers to the difference between the expected price of a trade (based on the current order book) and the actual price at which the trade is executed.

Name
MetricID
Unit
Interval

Order Book Slippage, 1K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 5K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 10K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 20K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 30K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 40K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 50K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 60K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 70K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 80K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 90K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 100K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 200K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 300K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 400K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 500K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 600K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 700K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 800K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 900K USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 1M USD Order, Ask, Percentage

Dimensionless

1h

Order Book Slippage, 1K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 5K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 10K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 20K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 30K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 40K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 50K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 60K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 70K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 80K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 90K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 100K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 200K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 300K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 400K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 500K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 600K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 700K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 800K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 900K USD Order, Bid, Percentage

Dimensionless

1h

Order Book Slippage, 1M USD Order, Bid, Percentage

Dimensionless

1h

Details

Price slippage is the difference, represented as a percentage, between the quoted price of an asset and the execution price of a market order. The bid slippage metrics represent the price slippage of a market sell order. And the ask slippage metrics represent the price slippage of a market buy order. The slippage reflects how much the price of the asset moves when buying or selling into the market. For instance, if you are purchasing a quantity of $1,000 worth of the asset, the slippage metric tells you how much higher the price will be than the price you would expect if there was no slippage (i.e., based purely on the current bid-ask spread).

The metric is calculated using the following steps:

Convert the market order in U.S. dollars to units of the base asset for spot markets and units of the contract:

Determine the cumulative bid or ask amount at increasing price levels including and above the best bid or ask. This is the total quantity of assets that are willing to be bought or available for sale at each price point:

Calculate the effective execution price as the volume-weighted average price of the orders that are required to fully execute the market order, taking into account that the last limit order that the market order matches with may only be partially executed:

Calculate the slippage as the percentage difference between the effective execution price at which the order is executed and the midprice (the price you would expect without slippage):

For example, let’s say an investor wishes to purchase 1 BTC at the best ask price of $25,000 and they submit a market order. The top of the order book has a sell order at this price for 0.25 BTC, so .25 BTC is purchased at $25,000 per BTC. The next order in the orderbook is for 0.5 BTC, but at a price of $25,250. This is executed and 0.5 BTC is purchased at $25,250 per BTC. 0.75 BTC has now been purchased, and 0.25 BTC remain. The investor completes his order at the next offer in the orderbook, 0.5 BTC for $25,500. As only 0.25 BTC are needed to complete the 1 BTC purchase, the investor fills 0.25 BTC at the price of $25,500 per BTC. The effective execution price of this purchase is the average price of the individual orders, weighted by quantity:

The slippage is the percentage difference in the market price and this execution price:

So this hypothetical purchase of 1 BTC incurred 1% slippage. If the trade size was different, then the slippage would change; that is, slippage is dependent on order size.

API Endpoints

Liquidity slippage 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_slippage_100K_ask_percent&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_slippage_100K_ask_percent&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_slippage_100K_ask_percent'], frequency='1h', limit_per_market=1
    ).to_dataframe()
)

Examples

A sample of the liquidity slippage percentage for a $100K buy order on the coinbase-btc-usd-spot market is shown below:

{
  "data" : [ {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T20:00:00.000000000Z",
    "liquidity_slippage_100K_ask_percent" : "0.038994542840022156"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T21:00:00.000000000Z",
    "liquidity_slippage_100K_ask_percent" : "0.02565041632600015"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T22:00:00.000000000Z",
    "liquidity_slippage_100K_ask_percent" : "0.023751750174591604"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-04T23:00:00.000000000Z",
    "liquidity_slippage_100K_ask_percent" : "0.012357077898177927"
  }, {
    "market" : "coinbase-btc-usd-spot",
    "time" : "2023-05-05T00:00:00.000000000Z",
    "liquidity_slippage_100K_ask_percent" : "0.004505088323999404"
  } ]
}
  • market: The id of the markets.

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

  • liquidity_slippage_100K_ask_percent: The percent slippage of a $100K buy order executed at this time in this market.

Frequently Asked Questions

Why are some of the values for some slippage metrics and observations missing?

Coin Metrics calculates slippage 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 slippage depth metric for a $X market order, 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 for a given order size) 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 order size.

What units are the slippage metrics in?

The values are in percent units. For example, if the value is 0.0076, it should be interpreted as 0.0076%.

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.

PreviousOrder Book DepthNextMarket Metadata

Last updated 2 months ago

Was this helpful?

Market Order Size (units)=Market Order Size (USD)Price of Base Asset (USD)\text{Market Order Size (units)} = \frac{\text{Market Order Size (USD)}}{\text{Price of Base Asset (USD)}}Market Order Size (units)=Price of Base Asset (USD)Market Order Size (USD)​

Market Order Size (contract units)=Market Order Size (USD)Contract Size×Contract Size Asset (USD)\text{Market Order Size (contract units)} = \frac{\text{Market Order Size (USD)}}{\text{Contract Size} \times \text{Contract Size Asset (USD)}}Market Order Size (contract units)=Contract Size×Contract Size Asset (USD)Market Order Size (USD)​

L(n)=∑i=1nQiL(n) = \sum_{i=1}^{n} Q_i L(n)=∑i=1n​Qi​

Find the price at which a $X market order in U.S. dollars can be fully executed. This is done by consuming the bid or ask orders starting at the best bid or ask and moving up the order book until $X worth of orders are filled. In other words, find the smallest nnn such that:

L(n)≥Market Order SizeL(n) \geq \text {Market Order Size}L(n)≥Market Order Size

Pexec=∑i=1nPimin⁡(Qi,X−L(i−1))∑i=1nmin⁡(Qi,X−L(i−1))P_{\text{exec}} = \frac{\sum_{i=1}^{n} P_i \min\left(Q_i, X - L(i-1) \right)}{\sum_{i=1}^{n} \min\left(Q_i, X - L(i-1) \right)}Pexec​=∑i=1n​min(Qi​,X−L(i−1))∑i=1n​Pi​min(Qi​,X−L(i−1))​

Liquidity Slippage $X Percent=(∣Pexec−Pmidprice∣Pmidprice)×100 \text{Liquidity Slippage } \$X \text{ Percent} = \left( \frac{\left| P_{\text{exec}} - P_{\text{midprice}} \right|}{P_{\text{midprice}}} \right) \times 100 Liquidity Slippage $X Percent=(Pmidprice​∣Pexec​−Pmidprice​∣​)×100

0.25×$25,000+0.5×$25,250+0.25×$25,5000.25+0.5+0.25=$25,250\frac{0.25\times\$25,000 + 0.5\times\$25,250 + 0.25\times\$25,500}{0.25 + 0.5 + 0.25} = \$25,2500.25+0.5+0.250.25×$25,000+0.5×$25,250+0.25×$25,500​=$25,250

$25,250−$25,000$25,000=1%\frac{\$25,250-\$25,000}{\$25,000} = 1\%$25,000$25,250−$25,000​=1%

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_slippage_1K_ask_percent
liquidity_slippage_5K_ask_percent
liquidity_slippage_10K_ask_percent
liquidity_slippage_20K_ask_percent
liquidity_slippage_30K_ask_percent
liquidity_slippage_40K_ask_percent
liquidity_slippage_50K_ask_percent
liquidity_slippage_60K_ask_percent
liquidity_slippage_70K_ask_percent
liquidity_slippage_80K_ask_percent
liquidity_slippage_90K_ask_percent
liquidity_slippage_100K_ask_percent
liquidity_slippage_200K_ask_percent
liquidity_slippage_300K_ask_percent
liquidity_slippage_400K_ask_percent
liquidity_slippage_500K_ask_percent
liquidity_slippage_600K_ask_percent
liquidity_slippage_700K_ask_percent
liquidity_slippage_800K_ask_percent
liquidity_slippage_900K_ask_percent
liquidity_slippage_1M_ask_percent
liquidity_slippage_1K_bid_percent
liquidity_slippage_5K_bid_percent
liquidity_slippage_10K_bid_percent
liquidity_slippage_20K_bid_percent
liquidity_slippage_30K_bid_percent
liquidity_slippage_40K_bid_percent
liquidity_slippage_50K_bid_percent
liquidity_slippage_60K_bid_percent
liquidity_slippage_70K_bid_percent
liquidity_slippage_80K_bid_percent
liquidity_slippage_90K_bid_percent
liquidity_slippage_100K_bid_percent
liquidity_slippage_200K_bid_percent
liquidity_slippage_300K_bid_percent
liquidity_slippage_400K_bid_percent
liquidity_slippage_500K_bid_percent
liquidity_slippage_600K_bid_percent
liquidity_slippage_700K_bid_percent
liquidity_slippage_800K_bid_percent
liquidity_slippage_900K_bid_percent
liquidity_slippage_1M_bid_percent

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 slippage metrics and observations missing?
  • What units are the slippage metrics in?
  • How often are the metrics calculated?
  • Release History