-
Notifications
You must be signed in to change notification settings - Fork 2
TRIX
essegisolutions edited this page Jan 13, 2018
·
8 revisions
This API returns the 1-day rate of change of a triple smooth exponential moving average (TRIX) values. The related REST API documentation is here
The very first thing to do before diving into TRIX calls is to include the right namespace.
using Avapi.AvapiTRIX
The TRIX 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 TRIX from it.
...
Int_TRIX trix =
connection.GetQueryObject_TRIX();
To perform a TRIX request you have 2 options:
- The request with constants:
IAvapiResponse_TRIX Query(string symbol,
TRIX_interval interval,
int time_period,
TRIX_series_type series_type);
- The request without constants:
IAvapiResponse_TRIX QueryPrimitive(string symbol,
string interval,
string time_period,
string series_type);
To perform an TRIX asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_TRIX> QueryAsync(string symbol,
TRIX_interval interval,
int time_period,
TRIX_series_type series_type);
- The request without constants:
async Task<IAvapiResponse_TRIX> QueryAsync(string symbol,
string interval,
string time_period,
string series_type);
The parameters below are needed to perform the TRIX 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 TRIX value.
- 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 implies the use of different enums:
- TRIX_interval
- TRIX_series_type
TRIX_interval: The time interval between two consecutive data points in the time series.
public enum TRIX_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
TRIX_series_type: The price type in the time series. The types supported are: close, open, high, low
public enum TRIX_series_type
{
none,
close,
open,
high,
low
}
The response of a TRIX request is an object that implements the IAvapiResponse_TRIX interface.
public interface IAvapiResponse_TRIX
{
string RawData
{
get;
}
IAvapiResponse_TRIX_Content Data
{
get;
}
}
The IAvapiResponse_TRIX 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_TRIX_Content.
Complete Example of a Console App: Display the result of a TRIX request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiTRIX;
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 TRIX query object
Int_TRIX trix =
connection.GetQueryObject_TRIX();
// Perform the TRIX request and get the result
IAvapiResponse_TRIX trixResponse =
trix.Query(
"MSFT",
Const_TRIX.TRIX_interval.n_1min,
10,
Const_TRIX.TRIX_series_type.close);
// Printout the results
Console.WriteLine("******** RAW DATA TRIX ********");
Console.WriteLine(trixResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA TRIX ********");
var data = trixResponse.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("SeriesType: " + data.MetaData.SeriesType);
Console.WriteLine("TimeZone: " + data.MetaData.TimeZone);
Console.WriteLine("========================");
Console.WriteLine("========================");
foreach (var technical in data.TechnicalIndicator)
{
Console.WriteLine("TRIX: " + technical.TRIX);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a TRIX request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiTRIX
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_TRIX m_trix;
private IAvapiResponse_TRIX m_trixResponse;
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 TRIX query object
m_trix = m_connection.GetQueryObject_TRIX();
base.OnLoad(e);
}
private async void TRIXAsyncButton_Click(object sender, EventArgs e)
{
// Perform the TRIX request and get the result
m_trixResponse =
await m_trix.QueryAsync(
"MSFT",
Const_TRIX.TRIX_interval.n_1min,
10,
Const_TRIX.TRIX_series_type.close);
// Show the results
resultTextBox.AppendText("******** RAW DATA TRIX ********" + "\n");
resultTextBox.AppendText(m_trixResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA TRIX ********" + "\n");
var data = m_trixResponse.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("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("TRIX: " + technical.TRIX + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}