Skip to content

Latest commit

 

History

History
586 lines (545 loc) · 17.5 KB

README.md

File metadata and controls

586 lines (545 loc) · 17.5 KB
Raw

Chainlink External Adapter for CryptoCompare

1.3.25

Base URL wss://streamer.cryptocompare.com/v2

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

Environment Variables

Required? Name Description Type Options Default
✅ API_KEY An API key that can be obtained from here string

Input Parameters

Every EA supports base input parameters from this list

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

Crypto Endpoint

NOTE: the price endpoint is temporarily still supported, however, is being deprecated. Please use the crypto endpoint instead.

Supported names for this endpoint are: crypto, marketcap, price, volume.

Input Params

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

Example

Request:

{
  "id": "1",
  "data": {
    "endpoint": "crypto",
    "resultPath": "PRICE",
    "base": "ETH",
    "quote": "BTC"
  },
  "debug": {
    "cacheKey": "Eao0YPhZDa3+RmRxiwOG5dAIIt0=",
    "batchCacheKey": "6G4SrlsKUEN/0QigWvu9oEaSELA=",
    "batchChildrenCacheKeys": [
      [
        "Eao0YPhZDa3+RmRxiwOG5dAIIt0=",
        {
          "id": "1",
          "data": {
            "endpoint": "crypto",
            "resultPath": "PRICE",
            "base": "ETH",
            "quote": "BTC"
          }
        }
      ]
    ]
  },
  "rateLimitMaxAge": 29201
}

Response:

{
  "jobRunID": "1",
  "data": {
    "RAW": {
      "ETH": {
        "BTC": {
          "TYPE": "5",
          "MARKET": "CCCAGG",
          "FROMSYMBOL": "ETH",
          "TOSYMBOL": "BTC",
          "FLAGS": "2052",
          "PRICE": 0.06543,
          "LASTUPDATE": 1634917845,
          "MEDIAN": 0.06541,
          "LASTVOLUME": 0.3667,
          "LASTVOLUMETO": 0.0239964813,
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": 426154.9210721772,
          "VOLUMEDAYTO": 44337.6725074485,
          "VOLUME24HOUR": 199268.35105042686,
          "VOLUME24HOURTO": 12999.111610148046,
          "OPENDAY": 0.06516,
          "HIGHDAY": 0.06595,
          "LOWDAY": 0.06486,
          "OPEN24HOUR": 0.06492,
          "HIGH24HOUR": 0.06595,
          "LOW24HOUR": 0.06438,
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": 21826.54200988967,
          "VOLUMEHOURTO": 1662.8001349818653,
          "OPENHOUR": 0.06539,
          "HIGHHOUR": 0.06563,
          "LOWHOUR": 0.06531,
          "TOPTIERVOLUME24HOUR": 196133.9280134269,
          "TOPTIERVOLUME24HOURTO": 12794.391640956886,
          "CHANGE24HOUR": 0.0005099999999999966,
          "CHANGEPCT24HOUR": 0.7855822550831739,
          "CHANGEDAY": 0.00027000000000000635,
          "CHANGEPCTDAY": 0.41436464088398767,
          "CHANGEHOUR": 0.00003999999999999837,
          "CHANGEPCTHOUR": 0.06117143294081415,
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": 117601698.8115,
          "MKTCAP": 7694679.153236445,
          "MKTCAPPENALTY": 0,
          "CIRCULATINGSUPPLY": 117601698.8115,
          "CIRCULATINGSUPPLYMKTCAP": 7694679.153236445,
          "TOTALVOLUME24H": 2239758.9103871463,
          "TOTALVOLUME24HTO": 146508.4089075496,
          "TOTALTOPTIERVOLUME24H": 2231978.1419115765,
          "TOTALTOPTIERVOLUME24HTO": 145999.6785563128,
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "DISPLAY": {
      "ETH": {
        "BTC": {
          "FROMSYMBOL": "Ξ",
          "TOSYMBOL": "Ƀ",
          "MARKET": "CryptoCompare Index",
          "PRICE": "Ƀ 0.06543",
          "LASTUPDATE": "Just now",
          "LASTVOLUME": "Ξ 0.3667",
          "LASTVOLUMETO": "Ƀ 0.02400",
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": "Ξ 426,154.9",
          "VOLUMEDAYTO": "Ƀ 44,337.7",
          "VOLUME24HOUR": "Ξ 199,268.4",
          "VOLUME24HOURTO": "Ƀ 12,999.1",
          "OPENDAY": "Ƀ 0.06516",
          "HIGHDAY": "Ƀ 0.06595",
          "LOWDAY": "Ƀ 0.06486",
          "OPEN24HOUR": "Ƀ 0.06492",
          "HIGH24HOUR": "Ƀ 0.06595",
          "LOW24HOUR": "Ƀ 0.06438",
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": "Ξ 21,826.5",
          "VOLUMEHOURTO": "Ƀ 1,662.80",
          "OPENHOUR": "Ƀ 0.06539",
          "HIGHHOUR": "Ƀ 0.06563",
          "LOWHOUR": "Ƀ 0.06531",
          "TOPTIERVOLUME24HOUR": "Ξ 196,133.9",
          "TOPTIERVOLUME24HOURTO": "Ƀ 12,794.4",
          "CHANGE24HOUR": "Ƀ 0.00051",
          "CHANGEPCT24HOUR": "0.79",
          "CHANGEDAY": "Ƀ 0.00027",
          "CHANGEPCTDAY": "0.41",
          "CHANGEHOUR": "Ƀ 0.000040",
          "CHANGEPCTHOUR": "0.06",
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": "Ξ 117,601,698.8",
          "MKTCAP": "Ƀ 7.69 M",
          "MKTCAPPENALTY": "0 %",
          "CIRCULATINGSUPPLY": "Ξ 117,601,698.8",
          "CIRCULATINGSUPPLYMKTCAP": "Ƀ 7.69 M",
          "TOTALVOLUME24H": "Ξ 2.24 M",
          "TOTALVOLUME24HTO": "Ƀ 146.51 K",
          "TOTALTOPTIERVOLUME24H": "Ξ 2.23 M",
          "TOTALTOPTIERVOLUME24HTO": "Ƀ 146.00 K",
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "result": 0.06543
  },
  "result": 0.06543,
  "statusCode": 200,
  "debug": {
    "batchablePropertyPath": [
      {
        "name": "base",
        "limit": 200
      },
      {
        "name": "quote",
        "limit": 20
      }
    ]
  },
  "providerStatusCode": 200
}
Additional Examples

Request:

{
  "id": "1",
  "data": {
    "endpoint": "marketcap",
    "resultPath": "MKTCAP",
    "base": "ETH",
    "quote": "BTC"
  },
  "debug": {
    "cacheKey": "KbqgFjuDtvts/CAPorCDKS6azZ0=",
    "batchCacheKey": "jn4lMO3NoQk/anX1RCCPMCMFBRU=",
    "batchChildrenCacheKeys": [
      [
        "KbqgFjuDtvts/CAPorCDKS6azZ0=",
        {
          "id": "1",
          "data": {
            "endpoint": "marketcap",
            "resultPath": "MKTCAP",
            "base": "ETH",
            "quote": "BTC"
          }
        }
      ]
    ]
  },
  "rateLimitMaxAge": 58402
}

Response:

{
  "jobRunID": "1",
  "data": {
    "RAW": {
      "ETH": {
        "BTC": {
          "TYPE": "5",
          "MARKET": "CCCAGG",
          "FROMSYMBOL": "ETH",
          "TOSYMBOL": "BTC",
          "FLAGS": "2052",
          "PRICE": 0.06543,
          "LASTUPDATE": 1634917845,
          "MEDIAN": 0.06541,
          "LASTVOLUME": 0.3667,
          "LASTVOLUMETO": 0.0239964813,
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": 426154.9210721772,
          "VOLUMEDAYTO": 44337.6725074485,
          "VOLUME24HOUR": 199268.35105042686,
          "VOLUME24HOURTO": 12999.111610148046,
          "OPENDAY": 0.06516,
          "HIGHDAY": 0.06595,
          "LOWDAY": 0.06486,
          "OPEN24HOUR": 0.06492,
          "HIGH24HOUR": 0.06595,
          "LOW24HOUR": 0.06438,
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": 21826.54200988967,
          "VOLUMEHOURTO": 1662.8001349818653,
          "OPENHOUR": 0.06539,
          "HIGHHOUR": 0.06563,
          "LOWHOUR": 0.06531,
          "TOPTIERVOLUME24HOUR": 196133.9280134269,
          "TOPTIERVOLUME24HOURTO": 12794.391640956886,
          "CHANGE24HOUR": 0.0005099999999999966,
          "CHANGEPCT24HOUR": 0.7855822550831739,
          "CHANGEDAY": 0.00027000000000000635,
          "CHANGEPCTDAY": 0.41436464088398767,
          "CHANGEHOUR": 0.00003999999999999837,
          "CHANGEPCTHOUR": 0.06117143294081415,
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": 117601698.8115,
          "MKTCAP": 7694679.153236445,
          "MKTCAPPENALTY": 0,
          "CIRCULATINGSUPPLY": 117601698.8115,
          "CIRCULATINGSUPPLYMKTCAP": 7694679.153236445,
          "TOTALVOLUME24H": 2239758.9103871463,
          "TOTALVOLUME24HTO": 146508.4089075496,
          "TOTALTOPTIERVOLUME24H": 2231978.1419115765,
          "TOTALTOPTIERVOLUME24HTO": 145999.6785563128,
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "DISPLAY": {
      "ETH": {
        "BTC": {
          "FROMSYMBOL": "Ξ",
          "TOSYMBOL": "Ƀ",
          "MARKET": "CryptoCompare Index",
          "PRICE": "Ƀ 0.06543",
          "LASTUPDATE": "Just now",
          "LASTVOLUME": "Ξ 0.3667",
          "LASTVOLUMETO": "Ƀ 0.02400",
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": "Ξ 426,154.9",
          "VOLUMEDAYTO": "Ƀ 44,337.7",
          "VOLUME24HOUR": "Ξ 199,268.4",
          "VOLUME24HOURTO": "Ƀ 12,999.1",
          "OPENDAY": "Ƀ 0.06516",
          "HIGHDAY": "Ƀ 0.06595",
          "LOWDAY": "Ƀ 0.06486",
          "OPEN24HOUR": "Ƀ 0.06492",
          "HIGH24HOUR": "Ƀ 0.06595",
          "LOW24HOUR": "Ƀ 0.06438",
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": "Ξ 21,826.5",
          "VOLUMEHOURTO": "Ƀ 1,662.80",
          "OPENHOUR": "Ƀ 0.06539",
          "HIGHHOUR": "Ƀ 0.06563",
          "LOWHOUR": "Ƀ 0.06531",
          "TOPTIERVOLUME24HOUR": "Ξ 196,133.9",
          "TOPTIERVOLUME24HOURTO": "Ƀ 12,794.4",
          "CHANGE24HOUR": "Ƀ 0.00051",
          "CHANGEPCT24HOUR": "0.79",
          "CHANGEDAY": "Ƀ 0.00027",
          "CHANGEPCTDAY": "0.41",
          "CHANGEHOUR": "Ƀ 0.000040",
          "CHANGEPCTHOUR": "0.06",
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": "Ξ 117,601,698.8",
          "MKTCAP": "Ƀ 7.69 M",
          "MKTCAPPENALTY": "0 %",
          "CIRCULATINGSUPPLY": "Ξ 117,601,698.8",
          "CIRCULATINGSUPPLYMKTCAP": "Ƀ 7.69 M",
          "TOTALVOLUME24H": "Ξ 2.24 M",
          "TOTALVOLUME24HTO": "Ƀ 146.51 K",
          "TOTALTOPTIERVOLUME24H": "Ξ 2.23 M",
          "TOTALTOPTIERVOLUME24HTO": "Ƀ 146.00 K",
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "result": 7694679.153236445
  },
  "result": 7694679.153236445,
  "statusCode": 200,
  "debug": {
    "batchablePropertyPath": [
      {
        "name": "base",
        "limit": 200
      },
      {
        "name": "quote",
        "limit": 20
      }
    ]
  },
  "providerStatusCode": 200
}

Request:

{
  "id": "1",
  "data": {
    "endpoint": "volume",
    "resultPath": "VOLUME24HOURTO",
    "base": "ETH",
    "quote": "BTC"
  },
  "debug": {
    "cacheKey": "b8cVkUXVyDdOe/are/9XZjUuFsw=",
    "batchCacheKey": "7tI8y8sPATDZY9jYxipk1dWrnus=",
    "batchChildrenCacheKeys": [
      [
        "b8cVkUXVyDdOe/are/9XZjUuFsw=",
        {
          "id": "1",
          "data": {
            "endpoint": "volume",
            "resultPath": "VOLUME24HOURTO",
            "base": "ETH",
            "quote": "BTC"
          }
        }
      ]
    ]
  },
  "rateLimitMaxAge": 87604
}

Response:

{
  "jobRunID": "1",
  "data": {
    "RAW": {
      "ETH": {
        "BTC": {
          "TYPE": "5",
          "MARKET": "CCCAGG",
          "FROMSYMBOL": "ETH",
          "TOSYMBOL": "BTC",
          "FLAGS": "2052",
          "PRICE": 0.06543,
          "LASTUPDATE": 1634917845,
          "MEDIAN": 0.06541,
          "LASTVOLUME": 0.3667,
          "LASTVOLUMETO": 0.0239964813,
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": 426154.9210721772,
          "VOLUMEDAYTO": 44337.6725074485,
          "VOLUME24HOUR": 199268.35105042686,
          "VOLUME24HOURTO": 12999.111610148046,
          "OPENDAY": 0.06516,
          "HIGHDAY": 0.06595,
          "LOWDAY": 0.06486,
          "OPEN24HOUR": 0.06492,
          "HIGH24HOUR": 0.06595,
          "LOW24HOUR": 0.06438,
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": 21826.54200988967,
          "VOLUMEHOURTO": 1662.8001349818653,
          "OPENHOUR": 0.06539,
          "HIGHHOUR": 0.06563,
          "LOWHOUR": 0.06531,
          "TOPTIERVOLUME24HOUR": 196133.9280134269,
          "TOPTIERVOLUME24HOURTO": 12794.391640956886,
          "CHANGE24HOUR": 0.0005099999999999966,
          "CHANGEPCT24HOUR": 0.7855822550831739,
          "CHANGEDAY": 0.00027000000000000635,
          "CHANGEPCTDAY": 0.41436464088398767,
          "CHANGEHOUR": 0.00003999999999999837,
          "CHANGEPCTHOUR": 0.06117143294081415,
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": 117601698.8115,
          "MKTCAP": 7694679.153236445,
          "MKTCAPPENALTY": 0,
          "CIRCULATINGSUPPLY": 117601698.8115,
          "CIRCULATINGSUPPLYMKTCAP": 7694679.153236445,
          "TOTALVOLUME24H": 2239758.9103871463,
          "TOTALVOLUME24HTO": 146508.4089075496,
          "TOTALTOPTIERVOLUME24H": 2231978.1419115765,
          "TOTALTOPTIERVOLUME24HTO": 145999.6785563128,
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "DISPLAY": {
      "ETH": {
        "BTC": {
          "FROMSYMBOL": "Ξ",
          "TOSYMBOL": "Ƀ",
          "MARKET": "CryptoCompare Index",
          "PRICE": "Ƀ 0.06543",
          "LASTUPDATE": "Just now",
          "LASTVOLUME": "Ξ 0.3667",
          "LASTVOLUMETO": "Ƀ 0.02400",
          "LASTTRADEID": "266555634",
          "VOLUMEDAY": "Ξ 426,154.9",
          "VOLUMEDAYTO": "Ƀ 44,337.7",
          "VOLUME24HOUR": "Ξ 199,268.4",
          "VOLUME24HOURTO": "Ƀ 12,999.1",
          "OPENDAY": "Ƀ 0.06516",
          "HIGHDAY": "Ƀ 0.06595",
          "LOWDAY": "Ƀ 0.06486",
          "OPEN24HOUR": "Ƀ 0.06492",
          "HIGH24HOUR": "Ƀ 0.06595",
          "LOW24HOUR": "Ƀ 0.06438",
          "LASTMARKET": "Binance",
          "VOLUMEHOUR": "Ξ 21,826.5",
          "VOLUMEHOURTO": "Ƀ 1,662.80",
          "OPENHOUR": "Ƀ 0.06539",
          "HIGHHOUR": "Ƀ 0.06563",
          "LOWHOUR": "Ƀ 0.06531",
          "TOPTIERVOLUME24HOUR": "Ξ 196,133.9",
          "TOPTIERVOLUME24HOURTO": "Ƀ 12,794.4",
          "CHANGE24HOUR": "Ƀ 0.00051",
          "CHANGEPCT24HOUR": "0.79",
          "CHANGEDAY": "Ƀ 0.00027",
          "CHANGEPCTDAY": "0.41",
          "CHANGEHOUR": "Ƀ 0.000040",
          "CHANGEPCTHOUR": "0.06",
          "CONVERSIONTYPE": "direct",
          "CONVERSIONSYMBOL": "",
          "SUPPLY": "Ξ 117,601,698.8",
          "MKTCAP": "Ƀ 7.69 M",
          "MKTCAPPENALTY": "0 %",
          "CIRCULATINGSUPPLY": "Ξ 117,601,698.8",
          "CIRCULATINGSUPPLYMKTCAP": "Ƀ 7.69 M",
          "TOTALVOLUME24H": "Ξ 2.24 M",
          "TOTALVOLUME24HTO": "Ƀ 146.51 K",
          "TOTALTOPTIERVOLUME24H": "Ξ 2.23 M",
          "TOTALTOPTIERVOLUME24HTO": "Ƀ 146.00 K",
          "IMAGEURL": "/media/37746238/eth.png"
        }
      }
    },
    "result": 12999.111610148046
  },
  "result": 12999.111610148046,
  "statusCode": 200,
  "debug": {
    "batchablePropertyPath": [
      {
        "name": "base",
        "limit": 200
      },
      {
        "name": "quote",
        "limit": 20
      }
    ]
  },
  "providerStatusCode": 200
}

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 the currency to query
✅ quote market, to, tsym The symbol of the currency to convert to
hours Number of hours to get VWAP for number 24

Example

Request:

{
  "id": "1",
  "data": {
    "endpoint": "vwap",
    "base": "AMPL",
    "quote": "USD",
    "hours": 24
  },
  "debug": {
    "cacheKey": "ktiYBaPq7+GA3M0Ss87tRIW2Nsw="
  },
  "rateLimitMaxAge": 116805
}

Response:

{
  "jobRunID": "1",
  "data": {
    "USD": 0.9224,
    "ConversionType": {
      "type": "direct",
      "conversionSymbol": ""
    },
    "result": 0.9224
  },
  "result": 0.9224,
  "statusCode": 200,
  "providerStatusCode": 200
}

MIT License