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