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