APIs

Total Returns (Yearly)

symbol_total_return_yr

Results

All historical yearly total returns of a global symbol for any given historical date range

Specification

Endpoint

symbol_total_return_yr?symbol={symbol}

Support
Current and Historical values

API Call Counts
50 per API call.

API Plan
silver

Quick Examples

Get yearly total returns of BTCUSD

https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key

Input Parameters

symbol

The common/local symbol/ticker of the symbol

Example : BTCUSD

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

year

The Year

Type: number

total_return

The total return of the symbol

Type: number

Sample Output

{
  "status": "ok",
  "total_records": 7,
  "page_size": 10,
  "current_page": 1,
  "total_pages": 1,
  "results": {
    "symbol": "BTCUSD",
    "symbol_name": "Bitcoin/US Dollar",
    "exchange": "gemini",
    "symbol_pair": "BTC/USD",
    "share_class_figi": null,
    "total_returns": [
      {
        "year": 2022,
        "total_return": -18.79702098417939
      },
      {
        "year": 2021,
        "total_return": 57.2014736532779
      },
      {
        "year": 2020,
        "total_return": 303.88755714126444
      },
      {
        "year": 2019,
        "total_return": 87.41091580513805
      },
      {
        "year": 2018,
        "total_return": -72.31789420020392
      },
      {
        "year": 2017,
        "total_return": 1284.0051273320848
      },
      {
        "year": 2016,
        "total_return": 56.70525808007718
      }
    ]
  }
}

Examples

Get yearly total returns of BTCUSD

https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key

REST

GET https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key

Python

import requests 
r = requests.get("https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&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=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key',
	port: 80,
	path: 'https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&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=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key");
	if (response.IsSuccessStatusCode)
	{
		//Your custom response parser code
	}
}

Java

String uri = "https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&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=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key'))
obj <- fromJSON(json)

PHP

$url = 'https://www.cryptoquote.io/analytics/v1/?api=symbol_total_return_yr&symbol=BTCUSD.gdax&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=symbol_total_return_yr&symbol=BTCUSD.gdax&key=your_api_key';
$.ajax({
		url: url,
		type: "GET",
		dataType: 'json'
}).done(function (data) {
	console.log(data);
});