Skip to content
essegisolutions edited this page Jan 13, 2018 · 8 revisions

What AD does?

This API returns the Chaikin A/D line (AD) values. The related REST API documentation is here


Including the AD namespace

The very first thing to do before diving into AD calls is to include the right namespace.


using Avapi.AvapiAD

How to get a AD object?

The AD 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 AD from it.


...
Int_AD ad = 
	connection.GetQueryObject_AD();

Perform a AD Synchronous Request

To perform a AD request you have 2 options:

  1. The request with constants:

IAvapiResponse_AD Query(string symbol,
		AD_interval interval);

  1. The request without constants:

IAvapiResponse_AD QueryPrimitive(string symbol,
		string interval);

Perform an AD Asynchronous Request

To perform an AD asynchronous request you have 2 options:

  1. The request with constants:

async Task<IAvapiResponse_AD> QueryAsync(string symbol,
		AD_interval interval);

  1. The request without constants:

async Task<IAvapiResponse_AD> QueryAsync(string symbol,
		string interval);

Parameters

The parameters below are needed to perform the AD request.

  • symbol: The name of the equity
  • interval: The time interval between two consecutive data points in the time series.

Please notice that the info above are copied from the official alphavantage documentation, that you can find here.


The request with constants

The request with constants implies the use of different enums:

  • AD_interval

AD_interval: The time interval between two consecutive data points in the time series.


public enum AD_interval
{
	none,
	n_1min,
	n_5min,
	n_15min,
	n_30min,
	n_60min,
	daily,
	weekly,
	monthly
}


AD Response

The response of a AD request is an object that implements the IAvapiResponse_AD interface.


public interface IAvapiResponse_AD
{
    string RawData
    {
        get;
    }
    IAvapiResponse_AD_Content Data
    {
        get;
    }
}

The IAvapiResponse_AD 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_AD_Content.

Complete Example of a Console App: Display the result of a AD request by using the method Query (synchronous request)


using System;
using System.IO;
using Avapi.AvapiAD;

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 AD query object
            Int_AD ad =
                connection.GetQueryObject_AD();

            // Perform the AD request and get the result
            IAvapiResponse_AD adResponse = 
            ad.Query(
                 "MSFT",
                 Const_AD.AD_interval.n_1min);

            // Printout the results
            Console.WriteLine("******** RAW DATA AD ********");
            Console.WriteLine(adResponse.RawData);

            Console.WriteLine("******** STRUCTURED DATA AD ********");
            var data = adResponse.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("TimeZone: " + data.MetaData.TimeZone);
                Console.WriteLine("========================");
                Console.WriteLine("========================");
                foreach (var technical in data.TechnicalIndicator)
                {
                    Console.WriteLine("ChaikinAD: " + technical.ChaikinAD);
                    Console.WriteLine("DateTime: " + technical.DateTime);
                    Console.WriteLine("========================");
                }
            }
        }
    }
}

Complete Example of a Windows Form App: Display the result of a AD request by using the method QueryAsync (asynchronous request)


using Avapi;
using Avapi.AvapiAD
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        private IAvapiConnection m_connection = AvapiConnection.Instance;
        private Int_AD m_ad;
        private IAvapiResponse_AD m_adResponse;

        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 AD query object
            m_ad = m_connection.GetQueryObject_AD();

            base.OnLoad(e);
        }

        private async void ADAsyncButton_Click(object sender, EventArgs e)
        {
            // Perform the AD request and get the result
            m_adResponse = 
                await m_ad.QueryAsync(
                     "MSFT",
                     Const_AD.AD_interval.n_1min);

             // Show the results
            resultTextBox.AppendText("******** RAW DATA AD ********" + "\n");
            resultTextBox.AppendText(m_adResponse.RawData + "\n");

            resultTextBox.AppendText("******** STRUCTURED DATA AD ********" + "\n");
            var data = m_adResponse.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("TimeZone: " + data.MetaData.TimeZone + "\n");
                resultTextBox.AppendText("========================" + "\n");
                resultTextBox.AppendText("========================" + "\n");
                foreach (var technical in data.TechnicalIndicator)
                {
                    resultTextBox.AppendText("ChaikinAD: " + technical.ChaikinAD + "\n");
                    resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
                    resultTextBox.AppendText("========================" + "\n");
                }
            }
        }
    }
}

Clone this wiki locally