README.md

COINMETRICS

This document was generated automatically. Please see README Generator for more info.

Environment Variables

Required?	Name	Description	Type	Options	Default
✅	API_KEY	The coinmetrics API key	string
	WS_API_ENDPOINT	The websocket url for coinmetrics	string		wss://api.coinmetrics.io/v4
	API_ENDPOINT	The API url for coinmetrics	string		https://api.coinmetrics.io/v4

---

Data Provider Rate Limits

Name	Requests/credits per second	Requests/credits per minute	Requests/credits per hour	Note
community		100
paid	300

---

Input Parameters

Required?	Name	Description	Type	Options	Default
	endpoint	The endpoint to use	string	burned, crypto-lwba, crypto, crypto_lwba, cryptolwba, price-ws, price, realized-vol, realized-volatility, total-burned	price

Price Endpoint

Supported names for this endpoint are: crypto, price, price-ws.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from	The symbol of symbols of the currency to query	string
✅	quote	market, to	The symbol of the currency to convert to	string	BTC, ETH, EUR, USD

Example

Request:

{
  "data": {
    "endpoint": "price",
    "base": "BTC",
    "quote": "USD"
  }
}

---

Crypto-lwba Endpoint

Supported names for this endpoint are: crypto-lwba, crypto_lwba, cryptolwba.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from	The symbol of symbols of the currency to query	string
✅	quote	market, to	The symbol of the currency to convert to	string

Example

Request:

{
  "data": {
    "endpoint": "crypto-lwba",
    "base": "ETH",
    "quote": "USD"
  }
}

---

Total-burned Endpoint

total-burned is the only supported name for this endpoint.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	asset		The symbol of the currency to query. See Coin Metrics Assets	string
	frequency		At which interval to calculate the number of coins/tokens burned	string	1b, 1d	1d
	pageSize		Number of results to get per page. From 1 to 10000	number		10000

Example

Request:

{
  "data": {
    "endpoint": "total-burned",
    "asset": "eth",
    "frequency": "1d",
    "pageSize": 10000
  }
}

---

Burned Endpoint

burned is the only supported name for this endpoint.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	asset		The symbol of the currency to query. See Coin Metrics Assets	string
	frequency		At which interval to calculate the number of coins/tokens burned	string	1b, 1d	1d
	pageSize		Number of results to get per page. From 1 to 10000	number		10000
	startTime		The start time for the queried period. See Supported DateTime Formats	string
	endTime		The end time for the queried period. See Supported DateTime Formats	string

Example

Request:

{
  "data": {
    "endpoint": "burned",
    "asset": "eth",
    "frequency": "1d",
    "pageSize": 1
  }
}

---

Realized-vol Endpoint

Supported names for this endpoint are: realized-vol, realized-volatility.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from	The base currency to query the realized volatility for	string
	quote	convert, to	The quote currency to convert the realized volatility to	string		USD
	resultPath		The field to return within the result path	string	realVol1Day, realVol30Day, realVol7Day	realVol30Day

Example

Request:

{
  "data": {
    "endpoint": "realized-vol",
    "base": "ETH",
    "quote": "USD",
    "resultPath": "realVol30Day"
  }
}

---

MIT License