-
Notifications
You must be signed in to change notification settings - Fork 2
ADXR
essegisolutions edited this page Jan 13, 2018
·
8 revisions
This API returns the average directional movement index rating (ADXR) values. The related REST API documentation is here
The very first thing to do before diving into ADXR calls is to include the right namespace.
using Avapi.AvapiADXR
The ADXR 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 ADXR from it.
...
Int_ADXR adxr =
connection.GetQueryObject_ADXR();
To perform a ADXR request you have 2 options:
- The request with constants:
IAvapiResponse_ADXR Query(string symbol,
ADXR_interval interval,
int time_period);
- The request without constants:
IAvapiResponse_ADXR QueryPrimitive(string symbol,
string interval,
string time_period);
To perform an ADXR asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_ADXR> QueryAsync(string symbol,
ADXR_interval interval,
int time_period);
- The request without constants:
async Task<IAvapiResponse_ADXR> QueryAsync(string symbol,
string interval,
string time_period);
The parameters below are needed to perform the ADXR 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 ADXR value.
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:
- ADXR_interval
ADXR_interval: The time interval between two consecutive data points in the time series.
public enum ADXR_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
The response of a ADXR request is an object that implements the IAvapiResponse_ADXR interface.
public interface IAvapiResponse_ADXR
{
string RawData
{
get;
}
IAvapiResponse_ADXR_Content Data
{
get;
}
}
The IAvapiResponse_ADXR 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_ADXR_Content.
Complete Example of a Console App: Display the result of a ADXR request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiADXR;
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 ADXR query object
Int_ADXR adxr =
connection.GetQueryObject_ADXR();
// Perform the ADXR request and get the result
IAvapiResponse_ADXR adxrResponse =
adxr.Query(
"MSFT",
Const_ADXR.ADXR_interval.n_1min,
10);
// Printout the results
Console.WriteLine("******** RAW DATA ADXR ********");
Console.WriteLine(adxrResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA ADXR ********");
var data = adxrResponse.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("TimeZone: " + data.MetaData.TimeZone);
Console.WriteLine("========================");
Console.WriteLine("========================");
foreach (var technical in data.TechnicalIndicator)
{
Console.WriteLine("ADXR: " + technical.ADXR);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a ADXR request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiADXR
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_ADXR m_adxr;
private IAvapiResponse_ADXR m_adxrResponse;
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 ADXR query object
m_adxr = m_connection.GetQueryObject_ADXR();
base.OnLoad(e);
}
private async void ADXRAsyncButton_Click(object sender, EventArgs e)
{
// Perform the ADXR request and get the result
m_adxrResponse =
await m_adxr.QueryAsync(
"MSFT",
Const_ADXR.ADXR_interval.n_1min,
10);
// Show the results
resultTextBox.AppendText("******** RAW DATA ADXR ********" + "\n");
resultTextBox.AppendText(m_adxrResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA ADXR ********" + "\n");
var data = m_adxrResponse.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("TimeZone: " + data.MetaData.TimeZone + "\n");
resultTextBox.AppendText("========================" + "\n");
resultTextBox.AppendText("========================" + "\n");
foreach (var technical in data.TechnicalIndicator)
{
resultTextBox.AppendText("ADXR: " + technical.ADXR + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}