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