Skip to content

HT_TRENDMODE

Jump to bottom
essegisolutions edited this page Jan 13, 2018 · 8 revisions

What HT_TRENDMODE does?

This API returns the Hilbert transform, trend vs cycle mode (HT_TRENDMODE) values. The related REST API documentation is here

Including the HT_TRENDMODE namespace

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


using Avapi.AvapiHT_TRENDMODE

How to get a HT_TRENDMODE object?

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


...
Int_HT_TRENDMODE httrendmode = 
	connection.GetQueryObject_HT_TRENDMODE();

Perform a HT_TRENDMODE Synchronous Request

To perform a HT_TRENDMODE request you have 2 options:

  1. The request with constants:

IAvapiResponse_HT_TRENDMODE Query(string symbol,
		HT_TRENDMODE_interval interval,
		HT_TRENDMODE_series_type series_type);
  1. The request without constants:

IAvapiResponse_HT_TRENDMODE QueryPrimitive(string symbol,
		string interval,
		string series_type);

Perform an HT_TRENDMODE Asynchronous Request

To perform an HT_TRENDMODE asynchronous request you have 2 options:

  1. The request with constants:

async Task<IAvapiResponse_HT_TRENDMODE> QueryAsync(string symbol,
		HT_TRENDMODE_interval interval,
		HT_TRENDMODE_series_type series_type);
  1. The request without constants:

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

Parameters

The parameters below are needed to perform the HT_TRENDMODE request.

  • symbol: The name of the equity
  • interval: The time interval between two consecutive data points in the time series.
  • 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

The request with constants implies the use of different enums:

  • HT_TRENDMODE_interval
  • HT_TRENDMODE_series_type

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


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

HT_TRENDMODE_series_type: The price type in the time series. The types supported are: close, open, high, low


public enum HT_TRENDMODE_series_type
{
	none,
	close,
	open,
	high,
	low
}

HT_TRENDMODE Response

The response of a HT_TRENDMODE request is an object that implements the IAvapiResponse_HT_TRENDMODE interface.


public interface IAvapiResponse_HT_TRENDMODE
{
    string RawData
    {
        get;
    }
    IAvapiResponse_HT_TRENDMODE_Content Data
    {
        get;
    }
}

The IAvapiResponse_HT_TRENDMODE 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_HT_TRENDMODE_Content.

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


using System;
using System.IO;
using Avapi.AvapiHT_TRENDMODE;

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 HT_TRENDMODE query object
            Int_HT_TRENDMODE ht_trendmode =
                connection.GetQueryObject_HT_TRENDMODE();

            // Perform the HT_TRENDMODE request and get the result
            IAvapiResponse_HT_TRENDMODE ht_trendmodeResponse = 
            ht_trendmode.Query(
                 "MSFT",
                 Const_HT_TRENDMODE.HT_TRENDMODE_interval.n_1min,
                 Const_HT_TRENDMODE.HT_TRENDMODE_series_type.close);

            // Printout the results
            Console.WriteLine("******** RAW DATA HT_TRENDMODE ********");
            Console.WriteLine(ht_trendmodeResponse.RawData);

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

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


using Avapi;
using Avapi.AvapiHT_TRENDMODE
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        private IAvapiConnection m_connection = AvapiConnection.Instance;
        private Int_HT_TRENDMODE m_ht_trendmode;
        private IAvapiResponse_HT_TRENDMODE m_ht_trendmodeResponse;

        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 HT_TRENDMODE query object
            m_ht_trendmode = m_connection.GetQueryObject_HT_TRENDMODE();

            base.OnLoad(e);
        }

        private async void HT_TRENDMODEAsyncButton_Click(object sender, EventArgs e)
        {
            // Perform the HT_TRENDMODE request and get the result
            m_ht_trendmodeResponse = 
                await m_ht_trendmode.QueryAsync(
                     "MSFT",
                     Const_HT_TRENDMODE.HT_TRENDMODE_interval.n_1min,
                     Const_HT_TRENDMODE.HT_TRENDMODE_series_type.close);

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

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

Clone this wiki locally