-
Notifications
You must be signed in to change notification settings - Fork 2
ROCR
essegisolutions edited this page Jan 13, 2018
·
8 revisions
This API returns the rate of change ratio (ROCR) values. The related REST API documentation is here
The very first thing to do before diving into ROCR calls is to include the right namespace.
using Avapi.AvapiROCR
The ROCR object is retrieved from the Connection object.
The snippet below shows how to get the Connection object:
...
IAvapiConnection connection = AvapiConnection.Instance
connection.Connect("Your Alpha Vantage API Key !!!!");
...
Once you got the Connection object you can extract the ROCR from it.
...
Int_ROCR rocr =
connection.GetQueryObject_ROCR();
To perform a ROCR request you have 2 options:
- The request with constants:
IAvapiResponse_ROCR Query(string symbol,
ROCR_interval interval,
int time_period,
ROCR_series_type series_type);
- The request without constants:
IAvapiResponse_ROCR QueryPrimitive(string symbol,
string interval,
string time_period,
string series_type);
To perform an ROCR asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_ROCR> QueryAsync(string symbol,
ROCR_interval interval,
int time_period,
ROCR_series_type series_type);
- The request without constants:
async Task<IAvapiResponse_ROCR> QueryAsync(string symbol,
string interval,
string time_period,
string series_type);
The parameters below are needed to perform the ROCR request.
- symbol: The name of the equity
- interval: The time interval between two consecutive data points in the time series.
- time_period: Number of data points used to calculate each ROCR value.
- series_type: The price type in the time series. The types supported are: close, open, high, low
Please notice that the info above are copied from the official alphavantage documentation, that you can find here.
The request with constants implies the use of different enums:
- ROCR_interval
- ROCR_series_type
ROCR_interval: The time interval between two consecutive data points in the time series.
public enum ROCR_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
ROCR_series_type: The price type in the time series. The types supported are: close, open, high, low
public enum ROCR_series_type
{
none,
close,
open,
high,
low
}
The response of a ROCR request is an object that implements the IAvapiResponse_ROCR interface.
public interface IAvapiResponse_ROCR
{
string RawData
{
get;
}
IAvapiResponse_ROCR_Content Data
{
get;
}
}
The IAvapiResponse_ROCR interface has two members: RawData and Data.
- RawData: represents the json response in string format.
- Data: It represents the parsed response in an object implementing the interface IAvapiResponse_ROCR_Content.
Complete Example of a Console App: Display the result of a ROCR request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiROCR;
namespace Avapi
{
public class Example
{
static void Main()
{
// Creating the connection object
IAvapiConnection connection = AvapiConnection.Instance;
// Set up the connection and pass the API_KEY provided by alphavantage.co
connection.Connect("Your Alpha Vantage API Key !!!!");
// Get the ROCR query object
Int_ROCR rocr =
connection.GetQueryObject_ROCR();
// Perform the ROCR request and get the result
IAvapiResponse_ROCR rocrResponse =
rocr.Query(
"MSFT",
Const_ROCR.ROCR_interval.n_1min,
10,
Const_ROCR.ROCR_series_type.close);
// Printout the results
Console.WriteLine("******** RAW DATA ROCR ********");
Console.WriteLine(rocrResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA ROCR ********");
var data = rocrResponse.Data;
if (data.Error)
{
Console.WriteLine(data.ErrorMessage);
}
else
{
Console.WriteLine("Symbol: " + data.MetaData.Symbol);
Console.WriteLine("Indicator: " + data.MetaData.Indicator);
Console.WriteLine("LastRefreshed: " + data.MetaData.LastRefreshed);
Console.WriteLine("Interval: " + data.MetaData.Interval);
Console.WriteLine("TimePeriod: " + data.MetaData.TimePeriod);
Console.WriteLine("SeriesType: " + data.MetaData.SeriesType);
Console.WriteLine("TimeZone: " + data.MetaData.TimeZone);
Console.WriteLine("========================");
Console.WriteLine("========================");
foreach (var technical in data.TechnicalIndicator)
{
Console.WriteLine("ROCR: " + technical.ROCR);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a ROCR request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiROCR
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_ROCR m_rocr;
private IAvapiResponse_ROCR m_rocrResponse;
public Form1()
{
InitializeComponent();
}
protected override void OnLoad(EventArgs e)
{
// Set up the connection and pass the API_KEY provided by alphavantage.co
m_connection.Connect("Your Alpha Vantage Key");
// Get the ROCR query object
m_rocr = m_connection.GetQueryObject_ROCR();
base.OnLoad(e);
}
private async void ROCRAsyncButton_Click(object sender, EventArgs e)
{
// Perform the ROCR request and get the result
m_rocrResponse =
await m_rocr.QueryAsync(
"MSFT",
Const_ROCR.ROCR_interval.n_1min,
10,
Const_ROCR.ROCR_series_type.close);
// Show the results
resultTextBox.AppendText("******** RAW DATA ROCR ********" + "\n");
resultTextBox.AppendText(m_rocrResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA ROCR ********" + "\n");
var data = m_rocrResponse.Data;
if (data.Error)
{
resultTextBox.AppendText(data.ErrorMessage + "\n");
}
else
{
resultTextBox.AppendText("Symbol: " + data.MetaData.Symbol + "\n");
resultTextBox.AppendText("Indicator: " + data.MetaData.Indicator + "\n");
resultTextBox.AppendText("LastRefreshed: " + data.MetaData.LastRefreshed + "\n");
resultTextBox.AppendText("Interval: " + data.MetaData.Interval + "\n");
resultTextBox.AppendText("TimePeriod: " + data.MetaData.TimePeriod + "\n");
resultTextBox.AppendText("SeriesType: " + data.MetaData.SeriesType + "\n");
resultTextBox.AppendText("TimeZone: " + data.MetaData.TimeZone + "\n");
resultTextBox.AppendText("========================" + "\n");
resultTextBox.AppendText("========================" + "\n");
foreach (var technical in data.TechnicalIndicator)
{
resultTextBox.AppendText("ROCR: " + technical.ROCR + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}