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