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