# Stablecoin Market Data

This namespace contains endpoints to retrieve metrics related to the value of tokens, including price, market cap, etc.

## Price OHLCV

> This endpoint returns metrics related to Stablecoin's Index Price.  \
> \
> Price OHLCV data consists of five metrics. \
> \`open\`, the opening price at the beginning of the window, \`close\`, USD closing price at the end of the window, \
> \`high\`, the highest USD price in a given window, \`low\`, the lowest USD price in a given window, \
> and \`volume\`, the total token volume traded in a given window.  \
> \
> At this endpoint, metrics are calculated by Minute, Hour and Day. \
> \
> Stablecoin Index Price is calculated by taking VWAP(Volume Weighted Average Price) of Stablecoin price data aggregated from global exchanges. You can check supported exchanges \[here]\(<https://www.notion.so/cqlive/Stablecoins-ERC20-Exchange-List-e33b9baeae094fb090983dc1e1183b05>).

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Market Data","description":"This namespace contains endpoints to retrieve metrics related to the value of tokens, including price, market cap, etc."}],"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":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window_mhd":{"description":"Currently we support `day`, `hour`, and `min`.","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":{"PriceOHLCVSC":{"description":"Price OHLCV Data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceOHLCVSCResponse"}}}}},"schemas":{"PriceOHLCVSCResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window_MDHB"},"data":{"type":"array","items":{"type":"object","required":["open","high","low","close","volume"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DDTHH:MM:SS (UTC time). This field only appears when window=block or window=min is used."},"open":{"type":"decimal","description":"opening price at the beginning of the window."},"high":{"type":"decimal","description":"opening price at the end of the window."},"low":{"type":"decimal","description":"The highest price in a given window."},"close":{"type":"decimal","description":"The lowest price in a given window."},"volume":{"type":"decimal","description":"The total traded amount in a given 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_MDHB":{"type":"string","description":"The size of window. It can be day, hour, min, or block and it depends on the user request."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."}}},"paths":{"/stablecoin/market-data/price-ohlcv":{"get":{"tags":["Stablecoin Market Data"],"summary":"Price OHLCV","description":"This endpoint returns metrics related to Stablecoin's Index Price.  \n\nPrice OHLCV data consists of five metrics. \n`open`, the opening price at the beginning of the window, `close`, USD closing price at the end of the window, \n`high`, the highest USD price in a given window, `low`, the lowest USD price in a given window, \nand `volume`, the total token volume traded in a given window.  \n\nAt this endpoint, metrics are calculated by Minute, Hour and Day. \n\nStablecoin Index Price is calculated by taking VWAP(Volume Weighted Average Price) of Stablecoin price data aggregated from global exchanges. You can check supported exchanges [here](https://www.notion.so/cqlive/Stablecoins-ERC20-Exchange-List-e33b9baeae094fb090983dc1e1183b05).","operationId":"getPriceOHLCVSC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window_mhd"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/PriceOHLCVSC"}}}}}}
```

## Capitalization

> This endpoint returns metrics related to market capitalization. We currently provide market\_cap, which is total market capitalization of the token, calculated by multiplying the circulating supply with its USD price(circulating\_supply \* price\_usd\_close).

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Market Data","description":"This namespace contains endpoints to retrieve metrics related to the value of tokens, including price, market cap, etc."}],"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":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window":{"description":"Currently we support `day` and `block`.","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":{"CapitalizationSC":{"description":"Market capitalization of the stable coin, calculated by total_supply * price_usd_close.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapitalizationSCResponse"}}}}},"schemas":{"CapitalizationSCResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["market_cap"],"properties":{"date":{"$ref":"#/components/schemas/Date"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"datetime":{"$ref":"#/components/schemas/Datetime"},"market_cap":{"type":"decimal","description":"Market capitalization of the stable coin, calculated by total_supply * price_usd_close."}}}}}}}},"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":{"type":"string","description":"The size of window. It can be day or block, and it depends on the user request."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."}}},"paths":{"/stablecoin/market-data/capitalization":{"get":{"tags":["Stablecoin Market Data"],"summary":"Capitalization","description":"This endpoint returns metrics related to market capitalization. We currently provide market_cap, which is total market capitalization of the token, calculated by multiplying the circulating supply with its USD price(circulating_supply * price_usd_close).","operationId":"getCapitalizationSC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/CapitalizationSC"}}}}}}
```