Skip to content

Latest commit

 

History

History
116 lines (81 loc) · 6.25 KB

README.md

File metadata and controls

116 lines (81 loc) · 6.25 KB
Raw

CFBENCHMARKS

2.4.4 v3

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

Environment Variables

Required? Name Description Type Options Default
✅ API_USERNAME Username for the CFBenchmarks API string
✅ API_PASSWORD Password for the CFBenchmarks API string
API_ENDPOINT The default REST API base url string https://www.cfbenchmarks.com/api
WS_API_ENDPOINT The default WebSocket API base url string wss://www.cfbenchmarks.com/ws/v4
API_SECONDARY Toggle using the secondary API base URLs boolean false
SECONDARY_API_ENDPOINT The secondary REST API base url that is toggled using API_SECONDARY string https://unregprod.cfbenchmarks.com/api
SECONDARY_WS_API_ENDPOINT The secondary WebSocket API base url that is toggled using API_SECONDARY string wss://unregprod.cfbenchmarks.com/ws/v4

Data Provider Rate Limits

There are no rate limits for this adapter.

Input Parameters

Required? Name Description Type Options Default
endpoint The endpoint to use string birc, crypto-lwba, crypto, crypto_lwba, cryptolwba, price, values crypto

Crypto Endpoint

Supported names for this endpoint are: crypto, price, values.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
index The ID of the index. Takes priority over base/quote when provided. string
base coin, from The symbol of symbols of the currency to query string
quote market, to The symbol of the currency to convert to string
adapterNameOverride Used internally for override and metrics, do not set this field string

Example

Request:

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

Birc Endpoint

birc is the only supported name for this endpoint.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
✅ tenor The tenor value to pull from the API response string 1M, 1W, 2M, 2W, 3M, 3W, 4M, 5M, SIRB

Example

Request:

{
  "data": {
    "endpoint": "birc",
    "tenor": "SIRB"
  }
}

Crypto-lwba Endpoint

Supported names for this endpoint are: crypto-lwba, crypto_lwba, cryptolwba.

Input Params

Required? Name Aliases Description Type Options Default Depends On Not Valid With
index The ID of the index. Takes priority over base/quote when provided. string
base coin, from The symbol of symbols of the currency to query string
quote market, to The symbol of the currency to convert to string
adapterNameOverride Used internally for override and metrics, do not set this field string

Example

Request:

{
  "data": {
    "endpoint": "crypto-lwba",
    "base": "LINK",
    "quote": "USD"
  }
}

MIT License