Events Impact Analysis

symbols_events


Results
Calculate event impacts on asset prices. The API provides you with the ability to define an event and then allows you to look at asset prices reactions on the event with best performing symbols with average returns and more.

Specification
Endpoint
symbols_events?symbol={symbol}&start_date={start_date}&end_date={end_date}&q={q}&symbols={symbols}&buy={buy}&buy_field={buy_field}&sell={sell}&sell_field={sell_field}

Support
Current and Historical values

API Call Counts
500 per API call.

API Plan
gold


Quick Examples

When BTCUSD returns < 2% between 2018-01-01 and 2020-01-01, then calculate average returns of BTCUSD,ETHUSD,BNBUSDT,BNBBTC, with buy on the event date and sell on 1 day after the event

https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2018-01-01&end_date=2020-01-27&q=return_1d~lt~-2&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key

When BTCUSD close price >2000 between 2019-11-01 and 2020-01-01, then calculate average returns of BTCUSD,ETHUSD,BNBUSDT,BNBBTC with buy on the event date and sell on 1 day after the event

https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key

Input Parameters
symbol

The common/local symbol/ticker of the symbol

Example : BTCUSD


start_date

Start Date

Example : 2019-01-01


end_date

End Date

Example : 2019-01-01


q

Define your filters e.g.
Close Price > 10 : close~gt~10
For details: See Filters

Example : close~10


symbols

input the symbols, seperated by commas (max 20)

Example : BTCUSD,ETHUSD


buy

The Buy conditions

Example : 1d


buy_field

The BUY field. Allowed fields are;

open_price = Open Price
high_price = High Price
low_price = Low Price
close_price = Close Price

Example : close_price


sell

The SELL condition

Example : day_event


sell_field

The SELL field. Allowed fields are;

open_price = Open Price
high_price = High Price
low_price = Low Price
close_price = Close Price

Example : close_price



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


open_price

The open price of the symbol

Type: number


open_price

Open Price

Type: number


high_price

The high price of the symbol

Type: number


high_price

High Price

Type: number


low_price

Low Price

Type: number


low_price

The low price of the symbol

Type: number


close_price

The close price of the symbol

Type: number


close_price

Close Price

Type: number


chg_1d

The 1 Day Change ($) of the symbol

Type: number


return_1d

The 1 Day Change (%) of the symbol

Type: number



Sample Output
{
  "status": "ok",
  "total_records": 1,
  "page_size": 1,
  "current_page": 1,
  "total_pages": 1,
  "results": [
    {
      "base_symbol": {
        "symbol": "BTCUSD",
        "symbol_name": "Bitcoin/US Dollar",
        "exchange": "gemini",
        "symbol_pair": "BTC/USD"
      },
      "event_info": {
        "event_condition": "return_1d~gt~1",
        "event_occurred_counts": 21,
        "bought": "day_event",
        "sold": "1d"
      },
      "average_returns": [
        {
          "symbol": "BTCUSD",
          "symbol_name": "Bitcoin/US Dollar",
          "exchange": "gemini",
          "symbol_pair": "BTC/USD",
          "close_price": 38771.15,
          "chg_1d": 771.15,
          "return_1d": 2.03,
          "postive_trades (%)": 60,
          "average_returns": 1.16
        }
      ]
    }
  ]
}

Examples

When BTCUSD returns < 2% between 2018-01-01 and 2020-01-01, then calculate average returns of BTCUSD,ETHUSD,BNBUSDT,BNBBTC, with buy on the event date and sell on 1 day after the event

https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2018-01-01&end_date=2020-01-27&q=return_1d~lt~-2&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key

When BTCUSD close price >2000 between 2019-11-01 and 2020-01-01, then calculate average returns of BTCUSD,ETHUSD,BNBUSDT,BNBBTC with buy on the event date and sell on 1 day after the event

https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key
REST
GET https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key
Python
import requests 
r = requests.get("https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&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=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key',
	port: 80,
	path: 'https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&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=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key");
	if (response.IsSuccessStatusCode)
	{
		//Your custom response parser code
	}
}
Java
String uri = "https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&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=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key'))
obj <- fromJSON(json)
PHP
$url = 'https://www.cryptoquote.io/analytics/v1/?api=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&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=symbols_events&symbol=BTCUSD.gdax&start_date=2019-11-01&end_date=2020-01-27&q=close~gt~2000&symbols=BTCUSD,ETHUSD,BNBUSDT,BNBBTC&buy=day_event&buy_field=open_price&sell=1d&sell_field=close_price&key=your_api_key';
$.ajax({
		url: url,
		type: "GET",
		dataType: 'json'
}).done(function (data) {
	console.log(data);
});