Average Returns

average_returns


Results
Calculate average returns for symbols

Specification
Endpoint
average_returns?symbols={symbols}&start_date={start_date}&end_date={end_date}

Support
Current and Historical values

API Call Counts
30 per API call.

API Plan
silver



Input Parameters
symbols

input the symbols, seperated by commas (max 20)

Example : BTCUSD,ETHUSD


start_date

Start Date

Example : 2019-01-01


end_date

End Date

Example : 2019-01-01



Output Descriptions
symbol

The common/local symbol/ticker of the symbol

Type: string


symbol_name

The name of the symbol

Type: string


exchange

the exchange code e.g. gemini

Type: string


symbol_pair

the exchange symbol pairs

Type: string


average_return

The average return number

Type: number



Sample Output
{
  "status": "ok",
  "total_records": 4,
  "page_size": 1,
  "current_page": 1,
  "total_pages": 1,
  "results": [
    {
      "symbol": "BNBBTC",
      "symbol_name": "Binance Coin/Bitcoin",
      "exchange": "kucoin",
      "symbol_pair": "BNB/BTC",
      "average_return": -0.05
    },
    {
      "symbol": "BTCUSD",
      "symbol_name": "Bitcoin/US Dollar",
      "exchange": "gemini",
      "symbol_pair": "BTC/USD",
      "average_return": -0.05
    },
    {
      "symbol": "ETHUSD",
      "symbol_name": "Ethereum/US Dollar",
      "exchange": "bitstamp",
      "symbol_pair": "ETH/USD",
      "average_return": -0.21
    },
    {
      "symbol": "BNBUSDT",
      "symbol_name": "Binance Coin/Tether",
      "exchange": "poloniex",
      "symbol_pair": "BNB/USDT",
      "average_return": -0.37
    }
  ]
}

REST
GET https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key
Python
import requests 
r = requests.get("https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key")
data = r.json()
print(data)
Node.js
var http = require('http');
var buffer = '';
var options = {
	host: 'https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key',
	port: 80,
	path: 'https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key',
	headers: headers
};
callback = function(response) {
	response.on('data', function (chunk) {
	buffer += chunk;
});
response.on('end', function () {
	// your code here if you want to use the results !
});
}

var req = http.get(options, callback).end();
C#
using (var client = new HttpClient())
{
	client.BaseAddress = new Uri("{$api_host}");
	client.DefaultRequestHeaders.Clear();
	//ADD Acept Header to tell the server what data type you want
	client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
	//SET Parameters
	HttpResponseMessage response = await client.GetAsync("https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key");
	if (response.IsSuccessStatusCode)
	{
		//Your custom response parser code
	}
}
Java
String uri = "https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key";
URL url = new URL(uri);
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
	connection.setRequestMethod("GET");
	connection.setRequestProperty("Accept", "application/json");
InputStream xml = connection.getInputStream();
R
1 - Install package
install.packages("RCurl")
install.packages("jsonlite")
2 - Request the data:
library('RCurl')
require('jsonlite')
json <- getURL(URLencode('https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key'))
obj <- fromJSON(json)
PHP
$url = 'https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key';
$handle = curl_init(); 
	curl_setopt($handle, CURLOPT_URL, $url);
	curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);

	$data = curl_exec($handle);
curl_close($handle);
//parse your data as per your needs....
Javascript
var url = 'https://www.cryptoquote.io/analytics/v1/?api=average_returns&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&start_date=2020-10-01&end_date=2021-11-20&key=your_api_key';
$.ajax({
		url: url,
		type: "GET",
		dataType: 'json'
}).done(function (data) {
	console.log(data);
});