BTC Market Indicator

This namespace contains endpoints to retrieve MVRV(Market-Value-to-Realized-Value), Estimated Leverage Ratio, and etc. We provide certain indicators to avoid any risks, assume upside or downside potentials, and give insights on the value of bitcoin. We also provide USD and USDT spot price of BTC from global exchanges and BTC index price. CryptoQuant's BTC index price is VWAP(Volume Weighted Average Price) of aggregated price data from all exchanges we provide. For more detailed information, please refer to the description of each metric.

Estimated Leverage Ratio

get

By dividing the open interest of an exchange by their BTC reserve, you can estimate a relative average user leverage. Whenever the leverage value reaches a high, there is rapid volatility. Similar to Open Interest, but more accurate because it reflects the growth of the exchange itself. This is experimental indicator but it seems this reflects market sentiment. You can see how aggressive people are and how conservative they are in terms of investment. For 'In Progress' exchanges, estimated leverage ratio is not supported yet even though they provide open interest. Go to Data Guide‣

Note: This endpoint does not support Point-In-Time (PIT) accuracy due to periodic updates to wallet address clustering. Historical data may change as new exchange wallets are discovered, added, and validated.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

exchangestringRequired

A derivative exchange from the table that we support. See here.

Example: bitmex

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

The amount of open interest of exchange divided by their BTC reserve

application/json

get

/btc/market-indicator/estimated-leverage-ratio

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/estimated-leverage-ratio?exchange=binance&window=day&from=20191001&limit=2"

200

The amount of open interest of exchange divided by their BTC reserve

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "estimated_leverage_ratio": null
      },
      {
        "date": "2019-10-01",
        "estimated_leverage_ratio": null
      }
    ]
  }
}

Stablecoin Supply Ratio

get

SSR(Stablecoin Supply Ratio) is a ratio of stablecoin supply in the whole cryptocurrency market where stablecoin is used as fiat substitute for trading. This means that the supply of stablecoin can be used to assess the potential buying pressure for bitcoin. The historical starting point is 2017-11-28 00:00:00. Go to Data Guide‣

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently, we only support day.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

stablecoin_supply_ratio

application/json

get

/btc/market-indicator/stablecoin-supply-ratio

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/stablecoin-supply-ratio?window=day&from=20191001&limit=2"

200

stablecoin_supply_ratio

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2020-07-29",
        "stablecoin_supply_ratio": null
      },
      {
        "date": "2020-07-28",
        "stablecoin_supply_ratio": null
      }
    ]
  }
}

MVRV

get

MVRV(Market-Value-to-Realized-Value) is a ratio of market_cap divided by realized_cap. It can be interpreted as the relationship between short-term and long-term investors (i.e. speculators vs hodlers). When this value is too high, BTC price may be overvalued, and if it is too low, there is a possibility that the price is undervalued. Go to Data Guide‣

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

mvrv

application/json

get

/btc/market-indicator/mvrv

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/mvrv?window=day&from=20191001&limit=2"

200

mvrv

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "mvrv": null
      },
      {
        "date": "2019-10-01",
        "mvrv": null
      }
    ]
  }
}

Spent Output Profit Ratio

get

sopr is abbreviation of Spent Output Profit Ratio. Spent Output Profit Ratio evaluates the profit ratio of the whole market participants by comparing the value of outputs at spent time to created time. sopr is a ratio that is calculated as the USD value of spent outputs at the spent time divided by the USD value of spent outputs at the created time. So you can see the value when UTxO destroyed. In a simple way, you can estimate the distribution of spent transaction output are in profit or not.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

spent_output_profit_ratio

application/json

get

/btc/market-indicator/sopr

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/sopr?window=day&from=20191001&limit=2"

200

spent_output_profit_ratio

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2020-07-29",
        "sopr": null,
        "a_sopr": null,
        "sth_sopr": null,
        "lth_sopr": null
      },
      {
        "date": "2020-07-28",
        "sopr": null,
        "a_sopr": null,
        "sth_sopr": null,
        "lth_sopr": null
      }
    ]
  }
}

SOPR Ratio

get

SOPR Ratio is calculated as long term holders' SOPR divided by short term holders' SOPR. Higher value of the ratio means higher spent profit of LTH over STH, which is usually useful for spotting market tops.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

Long term holders' SOPR divided by short term holders' SOPR.

application/json

get

/btc/market-indicator/sopr-ratio

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/sopr-ratio?window=day&from=20191001&limit=2"

200

Long term holders' SOPR divided by short term holders' SOPR.

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2020-07-29",
        "sopr_ratio": null
      },
      {
        "date": "2020-07-28",
        "sopr_ratio": null
      }
    ]
  }
}

Realized Price

get

Realized Price is calculated as Realized Cap divided by the total coin supply. It measures the average price weighted by the supply of what the entire market participants paid for their coins. It sometimes can be interpreted as the on-chain support or resistance price.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

Realized Cap divided by total supply.

application/json

get

/btc/market-indicator/realized-price

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/realized-price?window=day&from=20191001&limit=2"

200

Realized Cap divided by total supply.

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "realized_price": null
      },
      {
        "date": "2019-10-01",
        "realized_price": null
      }
    ]
  }
}

UTxO Realized Price Age Distribution

get

UTxO Realized Price Age Distribution is a set of realized prices along with age bands. The metrics help us to overview each cohort’s holding behavior by overlaying a set of different realized prices.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

windowstringOptional

Currently we support day, hour, and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

utxo-realized-price-age-distribution

application/json

get

/btc/market-indicator/utxo-realized-price-age-distribution

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/market-indicator/utxo-realized-price-age-distribution?window=day&from=20191001&limit=2"

200

utxo-realized-price-age-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0d_1d": null,
        "range_1d_1w": null,
        "range_1w_1m": null,
        "range_1m_3m": null,
        "range_3m_6m": null,
        "range_6m_12m": null,
        "range_12m_18m": null,
        "range_18m_2y": null,
        "range_2y_3y": null,
        "range_3y_5y": null,
        "range_5y_7y": null,
        "range_7y_10y": null,
        "range_10y_inf": null
      },
      {
        "date": "2019-10-01",
        "range_0d_1d": null,
        "range_1d_1w": null,
        "range_1w_1m": null,
        "range_1m_3m": null,
        "range_3m_6m": null,
        "range_6m_12m": null,
        "range_12m_18m": null,
        "range_18m_2y": null,
        "range_2y_3y": null,
        "range_3y_5y": null,
        "range_5y_7y": null,
        "range_7y_10y": null,
        "range_10y_inf": null
      }
    ]
  }
}