README.md

Chainlink OilpriceAPI External Adapter

Base URL https://api.oilpriceapi.com/v1/

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

Environment Variables

Required?	Name	Description	Type	Options	Default
✅	API_KEY		string

---

Data Provider Rate Limits

Name	Requests/credits per second	Requests/credits per minute	Requests/credits per hour	Note
hobby			13.69	only mentions monthly limits
business			136.9
enterprise			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	price	price

Price Endpoint

price is the only supported name for this endpoint.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	asset, from, market, type	The type of oil to get the price from		brent, bz, wti
	url		The endpoint to use			prices/latest

Example

Request:

{
  "id": "1",
  "data": {
    "base": "bz",
    "url": "prices/latest",
    "endpoint": "price"
  },
  "debug": {
    "cacheKey": "RPRR3Z04AWc/TGtHftP/S/2ByRc="
  },
  "rateLimitMaxAge": 292184
}

Response:

{
  "jobRunID": "1",
  "data": {
    "result": 70.71
  },
  "result": 70.71,
  "statusCode": 200,
  "providerStatusCode": 200
}

Additional Examples

Request:

{
  "id": "1",
  "data": {
    "base": "wti",
    "url": "prices/latest",
    "endpoint": "price"
  },
  "debug": {
    "cacheKey": "l95L0aoLWaAHs3sTSB6amSkhM1w="
  },
  "rateLimitMaxAge": 584368
}

Response:

{
  "jobRunID": "1",
  "data": {
    "result": 71.47
  },
  "result": 71.47,
  "statusCode": 200,
  "providerStatusCode": 200
}

---

MIT License