BTC Flow Indicator

This namespace contains endpoints to retrieve Fund Flow ratio, Miners' Position Index(MPI), 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.

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.

Miners' Position Index (MPI)

get

MPI(Miners’ Position Index) is a z score of a specific period. The period range must be 2 days or more and if not, it will return an error. mpi is an index to understand miners’ behavior by examining the total outflow of miners. It highlights periods where the value of Bitcoin’s outflow by miners on a daily basis has historically been extremely high or low. MPI values above 2 indicate that most of the miners are selling Bitcoin. MPI values under 0 indicate that there is less selling pressure by miners. 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

Miners' Position Index

application/json

get

/btc/flow-indicator/mpi

ShellJavaScriptNodeJSRubyPython

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

200

Miners' Position Index

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

Exchange Shutdown Index

get

Stay Ahead of Exchange Hacks. See hacks as they happen by identifying sudden increases and become zero in exchange outflows and hedge against potential risk.

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

An exchange from the table that we support. See here.

Example: binance

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

Exchange Shutdown Index

application/json

get

/btc/flow-indicator/exchange-shutdown-index

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/flow-indicator/exchange-shutdown-index?exchange=binance&window=day&from=20191001&limit=2"

200

Exchange Shutdown Index

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

Exchange Whale Ratio

get

Find Whale Focused Exchanges with Top 10 Inflows. Looking at the relative size of the top 10 inflows to total inflows, it is possible to discover which exchanges whales use. For example, as Gemini has mostly whales users, it is possible for the price to rise or fall dramatically. This has potential risks, but also the possibility of arbitrage.

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

An exchange from the table that we support. See here.

Example: binance

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 total BTC amount of top 10 inflow amount divided by the total BTC amount flowed into exchange

application/json

get

/btc/flow-indicator/exchange-whale-ratio

ShellJavaScriptNodeJSRubyPython

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

200

The total BTC amount of top 10 inflow amount divided by the total BTC amount flowed into exchange

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

Fund Flow Ratio

get

Fund Flow Ratio provides the amount of bitcoins that exchanges occupy among the bitcoins sent underlying the Bitcoin network. Knowing the amount of fund currently involved in trading can help you understand market volatility.

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

An exchange from the table that we support. See here.

Example: binance

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 total BTC inflow and outflow of exchange divided by the total BTC transferred on the Bitcoin network.

application/json

get

/btc/flow-indicator/fund-flow-ratio

ShellJavaScriptNodeJSRubyPython

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

200

The total BTC inflow and outflow of exchange divided by the total BTC transferred on the Bitcoin network.

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

Stablecoins Ratio

get

BTC reserve divided by all stablecoins reserve held by an exchange. This usually indicates potential sell pressure. Supported exchanges are determined by the concurrent validity of both BTC and Stablecoins (for at least 1 token).

Note: This endpoint supports a maximum of 1,000 entries per request.

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

An exchange that supports both BTC and Stablecoins. See here for BTC and for Stablecoins.

Example: binance

windowstringOptional

Currently, we support day and hour.

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: 1000Optional

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

Default: 100Example: 100

formatstringOptional

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

Default: jsonExample: json

Responses

200

Total BTC reserve divided by all stablecoins reserve held by an exchange.

application/json

get

/btc/flow-indicator/stablecoins-ratio

ShellJavaScriptNodeJSRubyPython

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

200

Total BTC reserve divided by all stablecoins reserve held by an exchange.

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

Exchange Inflow Age Distribution

get

Exchange Inflow Age Distribution is a set of active inflow to exchanges with age bands. This indicator summarizes the behaviors of long-term or short-term holders flowed into the exchanges. 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

exchangestringRequired

An exchange from the table that we support. See here.

Example: binance

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

exchange-inflow-age-distribution

application/json

get

/btc/flow-indicator/exchange-inflow-age-distribution

ShellJavaScriptNodeJSRubyPython

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

200

exchange-inflow-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
      }
    ]
  }
}

Exchange Inflow Supply Distribution

get

Exchange Inflow Supply Distribution is a set of active inflow to exchanges with balance (supply) bands. This indicator summarizes the behaviors of whales or retails flowed into the exchanges, 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

exchangestringRequired

An exchange from the table that we support. See here.

Example: binance

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

exchange-inflow-supply-distribution

application/json

get

/btc/flow-indicator/exchange-inflow-supply-distribution

ShellJavaScriptNodeJSRubyPython

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

200

exchange-inflow-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
      }
    ]
  }
}

Exchange Inflow CDD (Coin Days Destroyed)

get

Exchange Inflow CDD is a subset of Coin Days Destroyed (CDD) where coins are destroyed by flowing into exchanges. This indicator is noise-removed version of CDD with respect to exchange dumping signal.

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

An exchange from the table that we support. See here.

Example: binance

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

exchange-inflow-cdd

application/json

get

/btc/flow-indicator/exchange-inflow-cdd

ShellJavaScriptNodeJSRubyPython

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

200

exchange-inflow-cdd

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

Exchange Supply Ratio

get

Exchange Supply Ratio is calculated as exchange reserve divided by total supply. The metric measures how much tokens are reserved in the exchange relative to total supply of the token.

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

An exchange from the table that we support. See here.

Example: binance

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

Ratio of reserved token in the exchange relative to total supply.

application/json

get

/btc/flow-indicator/exchange-supply-ratio

ShellJavaScriptNodeJSRubyPython

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

200

Ratio of reserved token in the exchange relative to total supply.

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

Miner Supply Ratio

get

Miner Supply Ratio is calculated as miner reserve divided by total supply. The metric measures how much tokens are reserved in the miner relative to total supply of the token.

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

minerstringRequired

A mining pool from the table that we support. See here.

Example: f2pool

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

Ratio of reserved token in the miner relative to total supply.

application/json

get

/btc/flow-indicator/miner-supply-ratio

ShellJavaScriptNodeJSRubyPython

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

200

Ratio of reserved token in the miner relative to total supply.

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