Skip to content

Latest commit

 

History

History
147 lines (111 loc) · 5.99 KB

README.md

File metadata and controls

147 lines (111 loc) · 5.99 KB
Raw

Chainlink External Adapter for Coinbase

2.0.20 v2

Query information from Coinbase's API

Base URL wss://ws-feed.pro.coinbase.com

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

Environment Variables

Required? Name Description Type Options Default
API_ENDPOINT string https://api.coinbase.com
WS_API_ENDPOINT string wss://ws-feed.pro.coinbase.com
NFT_API_ENDPOINT The API endpoint for making NFT API requests (eg. https://nft-api.coinbase.com) string
NFT_API_AUTH_HEADER The CB-NFT-API-TOKEN header used to authorize NFT API requests string

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
public 6 180
private 10 300

Input Parameters

Every EA supports base input parameters from this list

Required? Name Description Type Options Default
endpoint The endpoint to use string crypto, nft-floor-price, nft-floor, price 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, price.

Input Params

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

Example

Request:

{
  "id": "1",
  "data": {
    "symbol": "BTC",
    "convert": "USD",
    "endpoint": "crypto"
  },
  "debug": {
    "cacheKey": "r6ZXhd+zEdyag6axryIefPg9QnI="
  },
  "rateLimitMaxAge": 370
}

Response:

{
  "jobRunID": "1",
  "data": {
    "data": {
      "base": "BTC",
      "currency": "USD",
      "amount": "57854.29"
    },
    "result": 57854.29
  },
  "result": 57854.29,
  "statusCode": 200,
  "providerStatusCode": 200
}

NftFloorPrice Endpoint

Get NFT floor price for a given network, contractAddress & metricName. Note: metricName defaults to ETH_FLOOR_PRICE_ESTIMATE_BASE; if you want to use a different metricName, you should also supply a custom resultPath

Supported names for this endpoint are: nft-floor, nft-floor-price.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
network The blockchain network to get data from string ethereum-mainnet, polygon-mainnet ethereum-mainnet
✅ contractAddress The NFT contract address string
metricName The metric name to query string ETH_FLOOR_PRICE_ESTIMATE_BASE

Example

Request:

{
  "id": "1",
  "data": {
    "network": "ethereum-mainnet",
    "contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
    "metricName": "ETH_FLOOR_PRICE_ESTIMATE_BASE",
    "endpoint": "nft-floor-price"
  },
  "debug": {
    "cacheKey": "SA0YvJOf1PUwIFpDT0mYnwqpb34="
  },
  "rateLimitMaxAge": 740
}

Response:

{
  "jobRunID": "1",
  "data": {
    "value": {
      "floor_price_estimate": "67.09079293",
      "updated_at": "2022-09-09T06:12:31Z"
    },
    "metricName": "eth_floor_price_estimate_base",
    "result": 67.09079293
  },
  "result": 67.09079293,
  "statusCode": 200,
  "providerStatusCode": 200
}

MIT License