Skip to content

Latest commit

 

History

History
175 lines (141 loc) · 5.86 KB

README.md

File metadata and controls

175 lines (141 loc) · 5.86 KB
Raw

Chainlink External Adapter for CurrencyLayer

2.0.28 v2

Base URL https://api.currencylayer.com

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
API_ENDPOINT string https://api.currencylayer.com

Data Provider Rate Limits

Name Requests/credits per second Requests/credits per minute Requests/credits per hour Note
free 0.342 only mentions monthly limit
basic 13.69
professional 136.98
business 684.93

Input Parameters

Every EA supports base input parameters from this list

Required? Name Description Type Options Default
endpoint The endpoint to use string convert, forex, live, price live

Convert Endpoint

convert 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 The symbol of the currency to query string
✅ quote market, to The symbol of the currency to convert to string
amount An amount of the currency number 1

Example

Request:

{
  "id": "1",
  "data": {
    "base": "BTC",
    "quote": "USD",
    "amount": 1,
    "endpoint": "convert"
  },
  "debug": {
    "cacheKey": "fE+e01CMPOlT/0yVAcTGT32JAlQ="
  }
}

Response:

{
  "jobRunID": "1",
  "data": {
    "success": true,
    "terms": "https://currencylayer.com/terms",
    "privacy": "https://currencylayer.com/privacy",
    "query": {
      "from": "BTC",
      "to": "USD",
      "amount": 1
    },
    "info": {
      "timestamp": 1635800883,
      "quote": 60535.74
    },
    "result": 60535.74
  },
  "result": 60535.74,
  "statusCode": 200,
  "providerStatusCode": 200
}

Live Endpoint

Returns a batched price comparison from one currency to a list of other currencies.

Supported names for this endpoint are: forex, live, price.

Input Params

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

Example

Request:

{
  "id": "1",
  "data": {
    "base": "BTC",
    "quote": "USD",
    "amount": 1,
    "endpoint": "live"
  },
  "debug": {
    "cacheKey": "K9RcNs7mmrcDzcLMwNlw++Rup8E=",
    "batchCacheKey": "JNljA7RWhMv9GbJ3cUT6sqqNk/E=",
    "batchChildrenCacheKeys": [
      [
        "K9RcNs7mmrcDzcLMwNlw++Rup8E=",
        {
          "id": "1",
          "data": {
            "base": "BTC",
            "quote": "USD",
            "amount": 1,
            "endpoint": "live"
          }
        }
      ]
    ]
  }
}

Response:

{
  "jobRunID": "1",
  "data": {
    "success": true,
    "terms": "https://currencylayer.com/terms",
    "privacy": "https://currencylayer.com/privacy",
    "timestamp": 1655821744,
    "source": "BTC",
    "quotes": {
      "BTCUSD": 21479.7756
    },
    "result": 21479.7756
  },
  "result": 21479.7756,
  "statusCode": 200,
  "debug": {
    "batchablePropertyPath": [
      {
        "name": "quote"
      }
    ]
  },
  "providerStatusCode": 200
}

MIT License