MACD - AvapiDotNet/Avapi GitHub Wiki
What MACD does?
This API returns the moving average convergence / divergence (MACD) values). The related REST API documentation is here
Including the MACD namespace
The very first thing to do before diving into MACD calls is to include the right namespace.
using Avapi.AvapiMACD
How to get a MACD object?
The MACD 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 MACD from it.
...
Int_MACD macd =
connection.GetQueryObject_MACD();
Perform a MACD Synchronous Request
To perform a MACD request you have 2 options:
- The request with constants:
IAvapiResponse_MACD Query(string symbol,
MACD_interval interval,
MACD_series_type series_type,
int fastperiod [OPTIONAL],
int slowperiod [OPTIONAL],
int signalperiod [OPTIONAL]);
- The request without constants:
IAvapiResponse_MACD QueryPrimitive(string symbol,
string interval,
string series_type,
string fastperiod [OPTIONAL],
string slowperiod [OPTIONAL],
string signalperiod [OPTIONAL]);
Perform an MACD Asynchronous Request
To perform an MACD asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_MACD> QueryAsync(string symbol,
MACD_interval interval,
MACD_series_type series_type,
int fastperiod [OPTIONAL],
int slowperiod [OPTIONAL],
int signalperiod [OPTIONAL]);
- The request without constants:
async Task<IAvapiResponse_MACD> QueryAsync(string symbol,
string interval,
string series_type,
string fastperiod [OPTIONAL],
string slowperiod [OPTIONAL],
string signalperiod [OPTIONAL]);
Parameters
The parameters below are needed to perform the MACD 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
- fastperiod [OPTIONAL]: It is a optional value; positive integers are accepted. By default, fastperiod=12
- slowperiod [OPTIONAL]: It is a optional value; positive integers are accepted. By default, slowperiod=26
- signalperiod [OPTIONAL]: It is a optional value; positive integers are accepted. By default, signalperiod=9
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:
- MACD_interval
- MACD_series_type
MACD_interval: The time interval between two consecutive data points in the time series.
public enum MACD_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
MACD_series_type: The price type in the time series. The types supported are: close, open, high, low
public enum MACD_series_type
{
none,
close,
open,
high,
low
}
MACD Response
The response of a MACD request is an object that implements the IAvapiResponse_MACD interface.
public interface IAvapiResponse_MACD
{
string RawData
{
get;
}
IAvapiResponse_MACD_Content Data
{
get;
}
}
The IAvapiResponse_MACD 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_MACD_Content.
Complete Example of a Console App: Display the result of a MACD request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiMACD;
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 MACD query object
Int_MACD macd =
connection.GetQueryObject_MACD();
// Perform the MACD request and get the result
IAvapiResponse_MACD macdResponse =
macd.Query(
"MSFT",
Const_MACD.MACD_interval.n_1min,
Const_MACD.MACD_series_type.close,
10,
10,
10);
// Printout the results
Console.WriteLine("******** RAW DATA MACD ********");
Console.WriteLine(macdResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA MACD ********");
var data = macdResponse.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("FastPeriod: " + data.MetaData.FastPeriod);
Console.WriteLine("SlowPeriod: " + data.MetaData.SlowPeriod);
Console.WriteLine("SignalPeriod: " + data.MetaData.SignalPeriod);
Console.WriteLine("SeriesType: " + data.MetaData.SeriesType);
Console.WriteLine("TimeZone: " + data.MetaData.TimeZone);
Console.WriteLine("========================");
Console.WriteLine("========================");
foreach (var technical in data.TechnicalIndicator)
{
Console.WriteLine("MACD_Hist: " + technical.MACD_Hist);
Console.WriteLine("MACD_Signal: " + technical.MACD_Signal);
Console.WriteLine("MACD: " + technical.MACD);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a MACD request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiMACD
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_MACD m_macd;
private IAvapiResponse_MACD m_macdResponse;
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 MACD query object
m_macd = m_connection.GetQueryObject_MACD();
base.OnLoad(e);
}
private async void MACDAsyncButton_Click(object sender, EventArgs e)
{
// Perform the MACD request and get the result
m_macdResponse =
await m_macd.QueryAsync(
"MSFT",
Const_MACD.MACD_interval.n_1min,
Const_MACD.MACD_series_type.close,
10,
10,
10);
// Show the results
resultTextBox.AppendText("******** RAW DATA MACD ********" + "\n");
resultTextBox.AppendText(m_macdResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA MACD ********" + "\n");
var data = m_macdResponse.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("FastPeriod: " + data.MetaData.FastPeriod + "\n");
resultTextBox.AppendText("SlowPeriod: " + data.MetaData.SlowPeriod + "\n");
resultTextBox.AppendText("SignalPeriod: " + data.MetaData.SignalPeriod + "\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("MACD_Hist: " + technical.MACD_Hist + "\n");
resultTextBox.AppendText("MACD_Signal: " + technical.MACD_Signal + "\n");
resultTextBox.AppendText("MACD: " + technical.MACD + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}