Skip to content

AROONOSC

essegisolutions edited this page Jan 13, 2018 · 8 revisions

What AROONOSC does?

This API returns the Aroon oscillator (AROONOSC) values. The related REST API documentation is here


Including the AROONOSC namespace

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


using Avapi.AvapiAROONOSC

How to get a AROONOSC object?

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


...
Int_AROONOSC aroonosc = 
	connection.GetQueryObject_AROONOSC();

Perform a AROONOSC Synchronous Request

To perform a AROONOSC request you have 2 options:

  1. The request with constants:

IAvapiResponse_AROONOSC Query(string symbol,
		AROONOSC_interval interval,
		int time_period);

  1. The request without constants:

IAvapiResponse_AROONOSC QueryPrimitive(string symbol,
		string interval,
		string time_period);

Perform an AROONOSC Asynchronous Request

To perform an AROONOSC asynchronous request you have 2 options:

  1. The request with constants:

async Task<IAvapiResponse_AROONOSC> QueryAsync(string symbol,
		AROONOSC_interval interval,
		int time_period);

  1. The request without constants:

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

Parameters

The parameters below are needed to perform the AROONOSC 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 AROONOSC value.

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:

  • AROONOSC_interval

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


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


AROONOSC Response

The response of a AROONOSC request is an object that implements the IAvapiResponse_AROONOSC interface.


public interface IAvapiResponse_AROONOSC
{
    string RawData
    {
        get;
    }
    IAvapiResponse_AROONOSC_Content Data
    {
        get;
    }
}

The IAvapiResponse_AROONOSC 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_AROONOSC_Content.

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


using System;
using System.IO;
using Avapi.AvapiAROONOSC;

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 AROONOSC query object
            Int_AROONOSC aroonosc =
                connection.GetQueryObject_AROONOSC();

            // Perform the AROONOSC request and get the result
            IAvapiResponse_AROONOSC aroonoscResponse = 
            aroonosc.Query(
                 "MSFT",
                 Const_AROONOSC.AROONOSC_interval.n_1min,
                 10);

            // Printout the results
            Console.WriteLine("******** RAW DATA AROONOSC ********");
            Console.WriteLine(aroonoscResponse.RawData);

            Console.WriteLine("******** STRUCTURED DATA AROONOSC ********");
            var data = aroonoscResponse.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("AROONOSC: " + technical.AROONOSC);
                    Console.WriteLine("DateTime: " + technical.DateTime);
                    Console.WriteLine("========================");
                }
            }
        }
    }
}

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


using Avapi;
using Avapi.AvapiAROONOSC
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        private IAvapiConnection m_connection = AvapiConnection.Instance;
        private Int_AROONOSC m_aroonosc;
        private IAvapiResponse_AROONOSC m_aroonoscResponse;

        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 AROONOSC query object
            m_aroonosc = m_connection.GetQueryObject_AROONOSC();

            base.OnLoad(e);
        }

        private async void AROONOSCAsyncButton_Click(object sender, EventArgs e)
        {
            // Perform the AROONOSC request and get the result
            m_aroonoscResponse = 
                await m_aroonosc.QueryAsync(
                     "MSFT",
                     Const_AROONOSC.AROONOSC_interval.n_1min,
                     10);

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

            resultTextBox.AppendText("******** STRUCTURED DATA AROONOSC ********" + "\n");
            var data = m_aroonoscResponse.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("AROONOSC: " + technical.AROONOSC + "\n");
                    resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
                    resultTextBox.AppendText("========================" + "\n");
                }
            }
        }
    }
}

Clone this wiki locally