README.md

CRYPTOCOMPARE

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

Environment Variables

Required?	Name	Description	Type	Options	Default
	API_ENDPOINT	The HTTP URL to retrieve data from	string		https://min-api.cryptocompare.com
	WS_API_ENDPOINT	The WS URL to retrieve data from	string		wss://client-axfioiyn03.ccdata.io
✅	API_KEY	The CryptoCompare API key	string
	WS_API_KEY	The websocket API key to authenticate with, if different from API_KEY	string		``
	WS_ENABLED	Whether data should be returned from websocket or not	boolean		true

---

Data Provider Rate Limits

Name	Requests/credits per second	Requests/credits per minute	Requests/credits per hour	Note
free			136.98
professional			342.46
corporate			1027.39
enterprise-lite			2083

---

Input Parameters

Required?	Name	Description	Type	Options	Default
	endpoint	The endpoint to use	string	crypto-vwap, crypto, marketcap, price, volume, vwap	crypto

Crypto Endpoint

Supported names for this endpoint are: crypto, price.

Input Params

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

Example

Request:

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

---

Vwap Endpoint

Supported names for this endpoint are: crypto-vwap, vwap.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from, fsym	The symbol of symbols of the currency to query	string
✅	quote	market, to, tsym	The symbol of the currency to convert to	string
	hours		Number of hours to get VWAP for	number		24

Example

Request:

{
  "data": {
    "endpoint": "vwap",
    "base": "AMPL",
    "quote": "USD",
    "hours": 24
  }
}

---

Volume Endpoint

volume is the only supported name for this endpoint.

Input Params

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

Example

Request:

{
  "data": {
    "endpoint": "volume",
    "base": "ETH",
    "quote": "USD"
  }
}

---

Marketcap Endpoint

marketcap is the only supported name for this endpoint.

Input Params

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

Example

Request:

{
  "data": {
    "endpoint": "marketcap",
    "base": "ETH",
    "quote": "USD"
  }
}

---

MIT License