BTC Network Indicator

This namespace contains endpoints to retrieve NVT ratio, Stock to Flow ratio, and etc. We provide certain indicators to avoid any risks, assume upside or downside potentials, and give insights on the value of bitcoin. For more detailed information, please refer to the description of each metric.

Stock to Flow

get

Stock to Flow is a metric used to assume bitcoin price based on its scarcity just like gold, silver, and other valuable objects that are limited in amount and costly to earn. The same model for evaluating the value of those objects can be adopted to assess the value of bitcoin. The scarcity is calculated by dividing currently circulating coins in the blockchain network to newly supplied coins. 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, 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

stock_to_flow, stock_to_flow_reversion

application/json

get

/btc/network-indicator/stock-to-flow

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/network-indicator/stock-to-flow?window=day&from=20191001&limit=2"

200

stock_to_flow, stock_to_flow_reversion

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

NVT

get

NVT(Network Value to Transaction) ratio is the network value(supply_total * price_usd) divided by tokens_transferred_total. nvt is a metric often used to determine whether Bitcoin price is overvalued or not. The theory behind this indicator is that the value of the token depends on how actively transactions take place on the network. 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

NVT(Network Value to Transaction) ratio

application/json

get

/btc/network-indicator/nvt

ShellJavaScriptNodeJSRubyPython

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

200

NVT(Network Value to Transaction) ratio

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

NVT Golden Cross

get

NVT Golden Cross is a modified index of NVT that provides local tops and bottoms. NVT Golden Cross values above 2.2 indicate that downside risk goes up. NVT Golden Cross values below -1.6 mean huge upside potential will occur. 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

nvt_golden_cross

application/json

get

/btc/network-indicator/nvt-golden-cross

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/network-indicator/nvt-golden-cross?window=day&from=20191001&limit=2"

200

nvt_golden_cross

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

NVM

get

NVM(Network Value to Metcalfe Ratio) is a metric based on Metcalfe’s law; the value of a network is proportional to the square of its nodes or user. NVM is a ratio of market cap divided by daily active address. Based on Metcalfe’s law, the value of bitcoin rises if the daily active addresses increase. Therefore, if the NVM value is relatively small, it means that the value of the network is underestimated and if the value is relatively high, it means that the value of the network is overestimated. 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

nvm

application/json

get

/btc/network-indicator/nvm

ShellJavaScriptNodeJSRubyPython

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

200

nvm

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

Puell Multiple

get

Puell Multiple is the mining revenue usd divided by MA 365 mining revenue usd. puell_multiple is a metric shows the historically low and high periods of the value of bitcoin issued daily, and at what point investors should buy bitcoin to get high returns. This indicator was created by David Puell. 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

puell_multiple

application/json

get

/btc/network-indicator/puell-multiple

ShellJavaScriptNodeJSRubyPython

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

200

puell_multiple

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

Coin Days Destroyed

get

Coin Days Destroyed reflects market participants who have been in the bitcoin on-chain for longer. This indicator gives more weight to long-term-holder position. cdd is the sum of products of spent transaction output alive days and its value. sa_cdd is abbreviation of supply-adjusted cdd. Since cdd increases as the newly created block mined, we need an indicator which normalize cdd value. sa_cdd is calculated by cdd over supply_total. average_sa_cdd is the average value of sa_cdd since genesis block. binary_cdd is the signal whether current sa_cdd is larger than average_sa_cdd or not. If sa_cdd > average_sa_cdd, then binary_cdd is 1. In conclusion, these indicators help us to estimate how whale's moving.

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

cdd

application/json

get

/btc/network-indicator/cdd

ShellJavaScriptNodeJSRubyPython

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

200

cdd

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

Mean Coin Age

get

Mean Coin Age is the mean value of products of bitcoin unspent transaction output alive days and its value. It is basically similar to cdd. But mca focuses on unspent transaction output. Mean Coin Dollar Age is the sum value of products of bitcoin unspent transaction output alive days, value, and price at the created time.

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

mca

application/json

get

/btc/network-indicator/mca

ShellJavaScriptNodeJSRubyPython

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

200

mca

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

Sum Coin Age

get

Sum Coin Age is the sum value of products of bitcoin unspent transaction output alive days and its value. It is basically similar to cdd. But sca focuses on unspent transaction output. Sum Coin Dollar Age is the sum value of products of bitcoin unspent transaction output alive days, value, and price at the created time.

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

sca

application/json

get

/btc/network-indicator/sca

ShellJavaScriptNodeJSRubyPython

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

200

sca

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

Sum Coin Age Distribution

get

This indicator shows the distribution of long-term holder and short-term holder with UTxO data. It is similar to UTxO distribution, but weighted by alive days to highlight long-term holder's distribution in different ranges. Each field is calculated as the sum of the products of bitcoin unspent transaction output alive days and its value in a given period, divided by their sum. If long-term SCA distribution ratio increases, then we can interpret this as one of bullish moment.

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

sca-distribution

application/json

get

/btc/network-indicator/sca-distribution

ShellJavaScriptNodeJSRubyPython

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

200

sca-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,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": 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,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      }
    ]
  }
}

Net Unrealized Profit and Loss

get

Net Unrealized Profit and Loss shows how different between market_cap and realized_cap. nupl is calculated as difference between market_cap and realized_cap divided by market_cap. If market_cap > realized_cap, then nupl > 0, which means bitcoin on-chain expected value is less than what they actually have. So this value will give selling pressure. nup is net unrealized profit, which is calculated as sum of products of UTxO's value and price difference between created and destroyed, divided by market_cap. nup only contains UTxOs in profit. nul is net unrealized loss. This is opposite indicator of nup. It only contains UTxOs in loss.

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

nupl

application/json

get

/btc/network-indicator/nupl

ShellJavaScriptNodeJSRubyPython

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

200

nupl

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

Net Realized Profit and Loss

get

Net Realized Profit/Loss metric presenting the net magnitude of profit, or loss realized by all holders spending coins. Realized Profit/Loss is assessed relative to the price when a coin last moved.

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

nrpl

application/json

get

/btc/network-indicator/nrpl

ShellJavaScriptNodeJSRubyPython

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

200

nrpl

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

Profit and Loss (UTxO)

get

Profit and Loss (UTxO) evaluates the number of UTxOs being in profit or not by comparing the price between created and destroyed. When the price at destroyed time is higher than created, this transaction is in profit.

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

pnl-utxo

application/json

get

/btc/network-indicator/pnl-utxo

ShellJavaScriptNodeJSRubyPython

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

200

pnl-utxo

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

Profit and Loss (Supply)

get

Profit and Loss (Supply) evaluates the sum of UTxOs being in profit or not by comparing the price between created and destroyed. These metrics are similar to the ones in Profit and Loss (UTxO) but differ from putting more weight on each UTxO with its value. Sometimes we want to know the exact alive bitcoin transaction output value in profit. pnl-supply will show it accuretely. pnl-supply is calculated as the sum of UTxO value.

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

pnl-supply

application/json

get

/btc/network-indicator/pnl-supply

ShellJavaScriptNodeJSRubyPython

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

200

pnl-supply

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

Dormancy

get

Average Dormancy (average_dormancy) is the average number of days destroyed per coin transacted. Supply-Adjusted Average Dormancy (sa_average_dormancy) is the average dormancy normalized by supply total, where supply total increases as more blocks mined.

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

The average number of days destroyed per coin transacted.

application/json

get

/btc/network-indicator/dormancy

ShellJavaScriptNodeJSRubyPython

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

200

The average number of days destroyed per coin transacted.

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

UTxO Age Distribution

get

UTxO Age Distribution is a set of active supply with age bands. This indicator summarizes the behaviors of long-term or short-term holders along with price actions. We provide the distribution values in native, USD, and percent values.

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-age-distribution

application/json

get

/btc/network-indicator/utxo-age-distribution

ShellJavaScriptNodeJSRubyPython

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

200

utxo-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,
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": 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,
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      }
    ]
  }
}

UTxO Realized Age Distribution

get

UTxO Realized Age Distribution is a set of active supply with age bands weighted by the price at UTxO created time. Similar to Realized Cap, this indicator summarizes the capitalization held by long-term or short-term holders (each band). We provide the distribution values in native, USD, and percent values.

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-age-distribution

application/json

get

/btc/network-indicator/utxo-realized-age-distribution

ShellJavaScriptNodeJSRubyPython

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

200

utxo-realized-age-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      },
      {
        "date": "2019-10-01",
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      }
    ]
  }
}

UTxO Count Age Distribution

get

UTxO Count Age Distribution is a set of active number of holders with age bands. This indicator summarizes how many long-term or short-term holders exist by each band. We provide the distribution values in native, and percent values.

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-count-age-distribution

application/json

get

/btc/network-indicator/utxo-count-age-distribution

ShellJavaScriptNodeJSRubyPython

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

200

utxo-count-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,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": 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,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      }
    ]
  }
}

Spent Output Age Distribution

get

Spent Output Age Distribution is a set of active sum of spent outputs with age bands. This indicator summarizes how much UTxOs are destroyed by long-term or short-term holders (each band). We provide the distribution values in native, USD, and percent values.

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

spent-output-age-distribution

application/json

get

/btc/network-indicator/spent-output-age-distribution

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/network-indicator/spent-output-age-distribution?window=day&from=20191001&limit=2"

200

spent-output-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,
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": 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,
        "range_0d_1d_usd": null,
        "range_1d_1w_usd": null,
        "range_1w_1m_usd": null,
        "range_1m_3m_usd": null,
        "range_3m_6m_usd": null,
        "range_6m_12m_usd": null,
        "range_12m_18m_usd": null,
        "range_18m_2y_usd": null,
        "range_2y_3y_usd": null,
        "range_3y_5y_usd": null,
        "range_5y_7y_usd": null,
        "range_7y_10y_usd": null,
        "range_10y_inf_usd": null,
        "range_0d_1d_percent": null,
        "range_1d_1w_percent": null,
        "range_1w_1m_percent": null,
        "range_1m_3m_percent": null,
        "range_3m_6m_percent": null,
        "range_6m_12m_percent": null,
        "range_12m_18m_percent": null,
        "range_18m_2y_percent": null,
        "range_2y_3y_percent": null,
        "range_3y_5y_percent": null,
        "range_5y_7y_percent": null,
        "range_7y_10y_percent": null,
        "range_10y_inf_percent": null
      }
    ]
  }
}

UTxO Supply Distribution

get

UTxO Supply Distribution is a set of active supply with balance (supply) bands. This indicator summarizes the behaviors of whales or retails separated by amount of coins they hold along with price actions. We provide the distribution values in native, and percent values.

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-supply-distribution

application/json

get

/btc/network-indicator/utxo-supply-distribution

ShellJavaScriptNodeJSRubyPython

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

200

utxo-supply-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      },
      {
        "date": "2019-10-01",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      }
    ]
  }
}

UTxO Realized Supply Distribution

get

UTxO Realized Supply Distribution is a set of active supply with balance (supply) bands weighted by the price at UTxO created time. Similar to Realized Cap, this indicator summarizes the capitalization held by whales or retails (each band). We provide the distribution values in USD, and percent values.

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-supply-distribution

application/json

get

/btc/network-indicator/utxo-realized-supply-distribution

ShellJavaScriptNodeJSRubyPython

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

200

utxo-realized-supply-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0_1_usd": null,
        "range_1_10_usd": null,
        "range_10_100_usd": null,
        "range_100_1k_usd": null,
        "range_1k_10k_usd": null,
        "range_10k_100k_usd": null,
        "range_100k_1M_usd": null,
        "range_1M_inf_usd": null,
        "range_0_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_100k_percent": null,
        "range_100k_1M_percent": null,
        "range_1M_inf_percent": null
      },
      {
        "date": "2019-10-01",
        "range_0_1_usd": null,
        "range_1_10_usd": null,
        "range_10_100_usd": null,
        "range_100_1k_usd": null,
        "range_1k_10k_usd": null,
        "range_10k_100k_usd": null,
        "range_100k_1M_usd": null,
        "range_1M_inf_usd": null,
        "range_0_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_100k_percent": null,
        "range_100k_1M_percent": null,
        "range_1M_inf_percent": null
      }
    ]
  }
}

UTxO Count Supply Distribution

get

UTxO Count Supply Distribution is a set of active number of holders with balance (supply) bands. This indicator summarizes how many whales and retails exist by each band. We provide the distribution values in native, and percent values.

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-count-supply-distribution

application/json

get

/btc/network-indicator/utxo-count-supply-distribution

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/network-indicator/utxo-count-supply-distribution?window=day&from=20191001&limit=2"

200

utxo-count-supply-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      },
      {
        "date": "2019-10-01",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      }
    ]
  }
}

Spent Output Supply Distribution

get

Spent Output Supply Distribution is a set of active sum of spent outputs with balance (supply) bands. This indicator summarizes how much UTxOs are destroyed by whales or retails (each band). We provide the distribution values in native, USD, and percent values.

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

spent-output-supply-distribution

application/json

get

/btc/network-indicator/spent-output-supply-distribution

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/network-indicator/spent-output-supply-distribution?window=day&from=20191001&limit=2"

200

spent-output-supply-distribution

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_1_usd": null,
        "range_1_10_usd": null,
        "range_10_100_usd": null,
        "range_100_1k_usd": null,
        "range_1k_10k_usd": null,
        "range_10k_100k_usd": null,
        "range_100k_1M_usd": null,
        "range_1M_inf_usd": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      },
      {
        "date": "2019-10-01",
        "range_0_001": null,
        "range_001_01": null,
        "range_01_1": null,
        "range_1_10": null,
        "range_10_100": null,
        "range_100_1k": null,
        "range_1k_10k": null,
        "range_10k_inf": null,
        "range_0_1_usd": null,
        "range_1_10_usd": null,
        "range_10_100_usd": null,
        "range_100_1k_usd": null,
        "range_1k_10k_usd": null,
        "range_10k_100k_usd": null,
        "range_100k_1M_usd": null,
        "range_1M_inf_usd": null,
        "range_0_001_percent": null,
        "range_001_01_percent": null,
        "range_01_1_percent": null,
        "range_1_10_percent": null,
        "range_10_100_percent": null,
        "range_100_1k_percent": null,
        "range_1k_10k_percent": null,
        "range_10k_inf_percent": null
      }
    ]
  }
}