BTC Fund Data

This namespace cointains endpoints to retreive metrics related to regulated funds such as trust, including market price, market volume, market premium, and digital asset holdings. These metrics are useful to measure sentiments of investors such as institutions in regulated market. All Symbol will be updated no later then UTC 12:00, this may be changed depending on update time of source data. Also the return value may be changed because of late updated fund.

Supported Symbols

Name	Symbol	Status	Source
All Symbol (BTC)	all_symbol	Validated	All Fund
Grayscale Bitcoin Trust (GBTC)	gbtc	Validated	Grayscale Investments
Grayscale Bitcoin Mini Trust (BTC)	btc	Validated	Grayscale Investments
iShares Bitcoin Trust ETF (IBIT)	ibit	Validated	BlackRock
Fidelity Bitcoin Fund ETF (FBTC)	fbtc	Validated	Fidelity
Bitwise Bitcoin ETF (BITB)	bitb	Validated	Bitwise
ARK 21Shares Bitcoin ETF (ARKB)	arkb	Validated	ARK Investment / 21Shares
Invesco Galaxy Bitcoin ETF (BTCO)	btco	Validated	Invesco
VanEck Bitcoin Trust (HODL)	hodl	Validated	VanEck
Franklin Bitcoin ETF (EZBC)	ezbc	Validated	Franklin Templeton
WisdomTree Bitcoin Fund (BTCW)	btcw	Validated	WisdomTree
The Coinshares Valkyrie Bitcoin Fund (BRRR)	brrr	Validated	Valkyrie
Purpose Bitcoin ETF (BTCC.U)	btcc_u	Validated	Purpose Investments
ETC Group Bitcoin ETF (BTCE)	btce	Validated	ETC Group

Market Price USD

get

The price of certain symbol (e.g. gbtc) managed by each fund (e.g. Grayscale) reflects sentiment of investors in regulated markets. In this specific case, having single share of GBTC means having approximately 0.001 BTC invested to Grayscale. This endpoint returns metrics related to the US Dollar(USD) price of fund related stocks (e.g. gbtc). We provide five metrics, price_usd_open, USD opening price at the beginning of the window, price_usd_close, USD closing price at the end of the window, price_usd_high, the highest USD price in a given window, price_usd_low, the lowest USD price in a given window, and price_usd_adj_close, USD adjusted closing price at the end of the window. All Symbol is not supported.

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

symbolstringRequired

A stock symbol (ticker) from the table that we support. See here

Example: gbtc

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

Market Price OHLC and adjusted C Data in USD

application/json

get

/btc/fund-data/market-price-usd

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/fund-data/market-price-usd?symbol=gbtc&window=day&from=20191001&limit=2"

200

Market Price OHLC and adjusted C Data in USD

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-10-02",
        "price_usd_open": null,
        "price_usd_high": null,
        "price_usd_low": null,
        "price_usd_close": null,
        "price_usd_adj_close": null
      },
      {
        "date": "2019-10-01",
        "price_usd_open": null,
        "price_usd_high": null,
        "price_usd_low": null,
        "price_usd_close": null,
        "price_usd_adj_close": null
      }
    ]
  }
}

Market Volume

get

The volume of certain symbol (e.g. gbtc) managed by each fund (e.g. Grayscale) reflects sentiment of investors in regulated markets. This endpoint returns traded volume of fund related stocks (e.g. gbtc). At this endpoint, metrics are calculated by Day. We provide one metric, volume, traded volume of the window.

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

symbolstringRequired

A stock symbol (ticker) from the table that we support. See here

Example: gbtc

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

Market Volume Data

application/json

get

/btc/fund-data/market-volume

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/fund-data/market-volume?symbol=gbtc&window=day&from=20191001&limit=2"

200

Market Volume Data

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

Market Premium

get

The premium of certain symbol (e.g. gbtc) is defined as (market price of the symbol - NAV) divided by NAV where NAV (Native Asset Value) is the current value of holdings (e.g. BTC price multiplied by BTC per Share). Higher the premium indicates market bullish, which also indicates downside risk. On the other hand, lower the premium indicates market bearish, which also indicates upside risk. All Symbol market premium is calculated by taking VWAP (Volume Weighted Average Ratio) of each fund data volume (usd).

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

symbolstringRequired

A stock symbol (ticker) from the table that we support. See here

Example: gbtc

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

Market Premium Data

application/json

get

/btc/fund-data/market-premium

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/fund-data/market-premium?symbol=gbtc&window=day&from=20191001&limit=2"

200

Market Premium Data

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

Digital Asset Holdings

get

This endpoint returns digital asset holdings status of each fund. For example, Grayscale BTC Holdings along with GBTC represents how much BTC Grayscale is holding for its investment. This metric indicates stock market's sentiment where higher the value means bullish sentiment of investors in stock market.

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

symbolstringRequired

A stock symbol (ticker) from the table that we support. See here

Example: gbtc

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

Digital Asset Holdings Data

application/json

get

/btc/fund-data/digital-asset-holdings

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/btc/fund-data/digital-asset-holdings?symbol=gbtc&window=day&from=20191001&limit=2"

200

Digital Asset Holdings Data

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