-
Notifications
You must be signed in to change notification settings - Fork 2
RSI
This API returns the relative strength index (RSI) values. The related REST API documentation is here
The very first thing to do before diving into RSI calls is to include the right namespace.
using Avapi.AvapiRSI
The RSI 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 RSI from it.
...
Int_RSI rsi =
connection.GetQueryObject_RSI();
To perform a RSI request you have 2 options:
- The request with constants:
IAvapiResponse_RSI Query(string symbol,
RSI_interval interval,
int time_period,
RSI_series_type series_type);
- The request without constants:
IAvapiResponse_RSI QueryPrimitive(string symbol,
string interval,
string time_period,
string series_type);
To perform an RSI asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_RSI> QueryAsync(string symbol,
RSI_interval interval,
int time_period,
RSI_series_type series_type);
- The request without constants:
async Task<IAvapiResponse_RSI> QueryAsync(string symbol,
string interval,
string time_period,
string series_type);
The parameters below are needed to perform the RSI 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 RSI 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:
- RSI_interval
- RSI_series_type
RSI_interval: The time interval between two consecutive data points in the time series.
public enum RSI_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
RSI_series_type: The price type in the time series. The types supported are: close, open, high, low
public enum RSI_series_type
{
none,
close,
open,
high,
low
}
The response of a RSI request is an object that implements the IAvapiResponse_RSI interface.
public interface IAvapiResponse_RSI
{
string RawData
{
get;
}
IAvapiResponse_RSI_Content Data
{
get;
}
}
The IAvapiResponse_RSI 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_RSI_Content.
Complete Example of a Console App: Display the result of a RSI request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiRSI;
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 RSI query object
Int_RSI rsi =
connection.GetQueryObject_RSI();
// Perform the RSI request and get the result
IAvapiResponse_RSI rsiResponse =
rsi.Query(
"MSFT",
Const_RSI.RSI_interval.n_1min,
10,
Const_RSI.RSI_series_type.close);
// Printout the results
Console.WriteLine("******** RAW DATA RSI ********");
Console.WriteLine(rsiResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA RSI ********");
var data = rsiResponse.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("RSI: " + technical.RSI);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a RSI request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiRSI
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_RSI m_rsi;
private IAvapiResponse_RSI m_rsiResponse;
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 RSI query object
m_rsi = m_connection.GetQueryObject_RSI();
base.OnLoad(e);
}
private async void RSIAsyncButton_Click(object sender, EventArgs e)
{
// Perform the RSI request and get the result
m_rsiResponse =
await m_rsi.QueryAsync(
"MSFT",
Const_RSI.RSI_interval.n_1min,
10,
Const_RSI.RSI_series_type.close);
// Show the results
resultTextBox.AppendText("******** RAW DATA RSI ********" + "\n");
resultTextBox.AppendText(m_rsiResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA RSI ********" + "\n");
var data = m_rsiResponse.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("RSI: " + technical.RSI + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}