README.md

KAIKO

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

Environment Variables

Required?	Name	Description	Type	Options	Default
✅	API_KEY	API KEY for KAIKO	string
	API_ENDPOINT	API endpoint for KAIKO	string		https://us.market-api.kaiko.io/v2/data

---

Data Provider Rate Limits

Name	Requests/credits per second	Requests/credits per minute	Requests/credits per hour	Note
default	100			Considered unlimited tier, but setting reasonable limits

---

Input Parameters

Required?	Name	Description	Type	Options	Default
	endpoint	The endpoint to use	string	crypto, price, realized-vol, realized-volatility, trades	trades

Trades Endpoint

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

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	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
	interval		The time interval to use in the query. NOTE: Changing this will likely require changing millisecondsAgo accordingly	string		2m
	millisecondsAgo		Number of milliseconds from the current time that will determine start_time to use in the query	string		86400000
	sort		Which way to sort the data returned in the query	string		desc

Example

There are no examples for this endpoint.

---

Realized-vol Endpoint

Supported names for this endpoint are: realized-vol, realized-volatility.

Input Params

Required?	Name	Aliases	Description	Type	Options	Default	Depends On	Not Valid With
✅	base	coin, from	The base currency to query the realized volatility for	string
	quote	convert, market, to	The quote currency to convert the realized volatility to	string		USD
	resultPath		The field to return within the result path	string	realVol1Day, realVol30Day, realVol7Day	realVol30Day

Example

Request:

{
  "data": {
    "endpoint": "realized-vol",
    "base": "ETH",
    "quote": "USD",
    "resultPath": "realVol30Day"
  }
}

---

MIT License