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