# 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
> 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.
```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"BTC Fund Data","description":"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.\n\n
\n\n### Supported Symbols\n| Name | Symbol | Status | Source |\n|--------------------------------------- |-------------|-------------|-----------------------|\n| All Symbol (BTC) | `all_symbol`| Validated | All Fund |\n| Grayscale Bitcoin Trust (GBTC) | `gbtc` | Validated | Grayscale Investments |\n| Grayscale Bitcoin Mini Trust (BTC) | `btc` | Validated | Grayscale Investments |\n| iShares Bitcoin Trust ETF (IBIT) | `ibit` | Validated | BlackRock |\n| Fidelity Bitcoin Fund ETF (FBTC) | `fbtc` | Validated | Fidelity |\n| Bitwise Bitcoin ETF (BITB) | `bitb` | Validated | Bitwise |\n| ARK 21Shares Bitcoin ETF (ARKB) | `arkb` | Validated | ARK Investment / 21Shares |\n| Invesco Galaxy Bitcoin ETF (BTCO) | `btco` | Validated | Invesco |\n| VanEck Bitcoin Trust (HODL) | `hodl` | Validated | VanEck |\n| Franklin Bitcoin ETF (EZBC) | `ezbc` | Validated | Franklin Templeton |\n| WisdomTree Bitcoin Fund (BTCW) | `btcw` | Validated | WisdomTree |\n| The Coinshares Valkyrie Bitcoin Fund (BRRR) | `brrr` | Validated | Valkyrie |\n| Purpose Bitcoin ETF (BTCC.U) | `btcc_u` | Validated | Purpose Investments |\n| ETC Group Bitcoin ETF (BTCE) | `btce` | Validated | ETC Group |"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"symbol_btc":{"description":"A stock symbol (ticker) from the table that we support. [See here](#tag/BTC-Fund-Data)","explode":false,"in":"query","name":"symbol","required":true,"schema":{"type":"string"},"style":"form"},"window_d":{"description":"Currently, we only support `day`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"MarketPriceUSD":{"description":"Market Price OHLC and adjusted C Data in USD","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketPriceUSDResponse"}}}}},"schemas":{"MarketPriceUSDResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_D"},"data":{"type":"array","items":{"type":"object","required":["price_usd_open","price_usd_high","price_usd_low","price_usd_close","price_usd_adj_close"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"price_usd_open":{"type":"decimal","description":"USD opening price at the beginning of the window."},"price_usd_high":{"type":"decimal","description":"The highest USD price in a given window."},"price_usd_low":{"type":"decimal","description":"The lowest USD price in a given window."},"price_usd_close":{"type":"decimal","description":"USD closing price at the end of the window."},"price_usd_adj_close":{"type":"decimal","description":"USD adjusted closing price at the end of the window."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_D":{"type":"string","description":"The size of window. This metric supports only day resolution."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/btc/fund-data/market-price-usd":{"get":{"tags":["BTC Fund Data"],"summary":"Market Price USD","description":"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.","operationId":"getBTCMarketPriceUSD","parameters":[{"$ref":"#/components/parameters/symbol_btc"},{"$ref":"#/components/parameters/window_d"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/MarketPriceUSD"}}}}}}
```
## Market Volume
> 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.
```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"BTC Fund Data","description":"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.\n\n
\n\n### Supported Symbols\n| Name | Symbol | Status | Source |\n|--------------------------------------- |-------------|-------------|-----------------------|\n| All Symbol (BTC) | `all_symbol`| Validated | All Fund |\n| Grayscale Bitcoin Trust (GBTC) | `gbtc` | Validated | Grayscale Investments |\n| Grayscale Bitcoin Mini Trust (BTC) | `btc` | Validated | Grayscale Investments |\n| iShares Bitcoin Trust ETF (IBIT) | `ibit` | Validated | BlackRock |\n| Fidelity Bitcoin Fund ETF (FBTC) | `fbtc` | Validated | Fidelity |\n| Bitwise Bitcoin ETF (BITB) | `bitb` | Validated | Bitwise |\n| ARK 21Shares Bitcoin ETF (ARKB) | `arkb` | Validated | ARK Investment / 21Shares |\n| Invesco Galaxy Bitcoin ETF (BTCO) | `btco` | Validated | Invesco |\n| VanEck Bitcoin Trust (HODL) | `hodl` | Validated | VanEck |\n| Franklin Bitcoin ETF (EZBC) | `ezbc` | Validated | Franklin Templeton |\n| WisdomTree Bitcoin Fund (BTCW) | `btcw` | Validated | WisdomTree |\n| The Coinshares Valkyrie Bitcoin Fund (BRRR) | `brrr` | Validated | Valkyrie |\n| Purpose Bitcoin ETF (BTCC.U) | `btcc_u` | Validated | Purpose Investments |\n| ETC Group Bitcoin ETF (BTCE) | `btce` | Validated | ETC Group |"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"symbol_btc":{"description":"A stock symbol (ticker) from the table that we support. [See here](#tag/BTC-Fund-Data)","explode":false,"in":"query","name":"symbol","required":true,"schema":{"type":"string"},"style":"form"},"window_d":{"description":"Currently, we only support `day`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"MarketVolume":{"description":"Market Volume Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketVolumeResponse"}}}}},"schemas":{"MarketVolumeResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_D"},"data":{"type":"array","items":{"type":"object","required":["volume"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"volume":{"type":"decimal","description":"Traded volume of the window."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_D":{"type":"string","description":"The size of window. This metric supports only day resolution."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/btc/fund-data/market-volume":{"get":{"tags":["BTC Fund Data"],"summary":"Market Volume","description":"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.","operationId":"getBTCMarketVolume","parameters":[{"$ref":"#/components/parameters/symbol_btc"},{"$ref":"#/components/parameters/window_d"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/MarketVolume"}}}}}}
```
## Market Premium
> 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).
```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"BTC Fund Data","description":"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.\n\n
\n\n### Supported Symbols\n| Name | Symbol | Status | Source |\n|--------------------------------------- |-------------|-------------|-----------------------|\n| All Symbol (BTC) | `all_symbol`| Validated | All Fund |\n| Grayscale Bitcoin Trust (GBTC) | `gbtc` | Validated | Grayscale Investments |\n| Grayscale Bitcoin Mini Trust (BTC) | `btc` | Validated | Grayscale Investments |\n| iShares Bitcoin Trust ETF (IBIT) | `ibit` | Validated | BlackRock |\n| Fidelity Bitcoin Fund ETF (FBTC) | `fbtc` | Validated | Fidelity |\n| Bitwise Bitcoin ETF (BITB) | `bitb` | Validated | Bitwise |\n| ARK 21Shares Bitcoin ETF (ARKB) | `arkb` | Validated | ARK Investment / 21Shares |\n| Invesco Galaxy Bitcoin ETF (BTCO) | `btco` | Validated | Invesco |\n| VanEck Bitcoin Trust (HODL) | `hodl` | Validated | VanEck |\n| Franklin Bitcoin ETF (EZBC) | `ezbc` | Validated | Franklin Templeton |\n| WisdomTree Bitcoin Fund (BTCW) | `btcw` | Validated | WisdomTree |\n| The Coinshares Valkyrie Bitcoin Fund (BRRR) | `brrr` | Validated | Valkyrie |\n| Purpose Bitcoin ETF (BTCC.U) | `btcc_u` | Validated | Purpose Investments |\n| ETC Group Bitcoin ETF (BTCE) | `btce` | Validated | ETC Group |"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"symbol_btc":{"description":"A stock symbol (ticker) from the table that we support. [See here](#tag/BTC-Fund-Data)","explode":false,"in":"query","name":"symbol","required":true,"schema":{"type":"string"},"style":"form"},"window_d":{"description":"Currently, we only support `day`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"MarketPremium":{"description":"Market Premium Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketPremiumResponse"}}}}},"schemas":{"MarketPremiumResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_D"},"data":{"type":"array","items":{"type":"object","required":["market_premium"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"market_premium":{"type":"decimal","description":"Market premium of the window."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_D":{"type":"string","description":"The size of window. This metric supports only day resolution."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/btc/fund-data/market-premium":{"get":{"tags":["BTC Fund Data"],"summary":"Market Premium","description":"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).","operationId":"getBTCMarketPremium","parameters":[{"$ref":"#/components/parameters/symbol_btc"},{"$ref":"#/components/parameters/window_d"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/MarketPremium"}}}}}}
```
## Digital Asset Holdings
> 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.
```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"BTC Fund Data","description":"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.\n\n
\n\n### Supported Symbols\n| Name | Symbol | Status | Source |\n|--------------------------------------- |-------------|-------------|-----------------------|\n| All Symbol (BTC) | `all_symbol`| Validated | All Fund |\n| Grayscale Bitcoin Trust (GBTC) | `gbtc` | Validated | Grayscale Investments |\n| Grayscale Bitcoin Mini Trust (BTC) | `btc` | Validated | Grayscale Investments |\n| iShares Bitcoin Trust ETF (IBIT) | `ibit` | Validated | BlackRock |\n| Fidelity Bitcoin Fund ETF (FBTC) | `fbtc` | Validated | Fidelity |\n| Bitwise Bitcoin ETF (BITB) | `bitb` | Validated | Bitwise |\n| ARK 21Shares Bitcoin ETF (ARKB) | `arkb` | Validated | ARK Investment / 21Shares |\n| Invesco Galaxy Bitcoin ETF (BTCO) | `btco` | Validated | Invesco |\n| VanEck Bitcoin Trust (HODL) | `hodl` | Validated | VanEck |\n| Franklin Bitcoin ETF (EZBC) | `ezbc` | Validated | Franklin Templeton |\n| WisdomTree Bitcoin Fund (BTCW) | `btcw` | Validated | WisdomTree |\n| The Coinshares Valkyrie Bitcoin Fund (BRRR) | `brrr` | Validated | Valkyrie |\n| Purpose Bitcoin ETF (BTCC.U) | `btcc_u` | Validated | Purpose Investments |\n| ETC Group Bitcoin ETF (BTCE) | `btce` | Validated | ETC Group |"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"symbol_btc":{"description":"A stock symbol (ticker) from the table that we support. [See here](#tag/BTC-Fund-Data)","explode":false,"in":"query","name":"symbol","required":true,"schema":{"type":"string"},"style":"form"},"window_d":{"description":"Currently, we only support `day`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"DigitalAssetHoldings":{"description":"Digital Asset Holdings Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalAssetHoldingsResponse"}}}}},"schemas":{"DigitalAssetHoldingsResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_D"},"data":{"type":"array","items":{"type":"object","required":["digital_asset_holdings"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"digital_asset_holdings":{"type":"decimal","description":"Digital Asset Holdings of the window."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window_D":{"type":"string","description":"The size of window. This metric supports only day resolution."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/btc/fund-data/digital-asset-holdings":{"get":{"tags":["BTC Fund Data"],"summary":"Digital Asset Holdings","description":"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.","operationId":"getBTCDigitalAssetHoldings","parameters":[{"$ref":"#/components/parameters/symbol_btc"},{"$ref":"#/components/parameters/window_d"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/DigitalAssetHoldings"}}}}}}
```