-
Notifications
You must be signed in to change notification settings - Fork 2
CCI
essegisolutions edited this page Jan 13, 2018
·
8 revisions
This API returns the commodity channel index (CCI) values. The related REST API documentation is here
The very first thing to do before diving into CCI calls is to include the right namespace.
using Avapi.AvapiCCI
The CCI 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 CCI from it.
...
Int_CCI cci =
connection.GetQueryObject_CCI();
To perform a CCI request you have 2 options:
- The request with constants:
IAvapiResponse_CCI Query(string symbol,
CCI_interval interval,
int time_period);
- The request without constants:
IAvapiResponse_CCI QueryPrimitive(string symbol,
string interval,
string time_period);
To perform an CCI asynchronous request you have 2 options:
- The request with constants:
async Task<IAvapiResponse_CCI> QueryAsync(string symbol,
CCI_interval interval,
int time_period);
- The request without constants:
async Task<IAvapiResponse_CCI> QueryAsync(string symbol,
string interval,
string time_period);
The parameters below are needed to perform the CCI 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 CCI value.
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:
- CCI_interval
CCI_interval: The time interval between two consecutive data points in the time series.
public enum CCI_interval
{
none,
n_1min,
n_5min,
n_15min,
n_30min,
n_60min,
daily,
weekly,
monthly
}
The response of a CCI request is an object that implements the IAvapiResponse_CCI interface.
public interface IAvapiResponse_CCI
{
string RawData
{
get;
}
IAvapiResponse_CCI_Content Data
{
get;
}
}
The IAvapiResponse_CCI 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_CCI_Content.
Complete Example of a Console App: Display the result of a CCI request by using the method Query (synchronous request)
using System;
using System.IO;
using Avapi.AvapiCCI;
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 CCI query object
Int_CCI cci =
connection.GetQueryObject_CCI();
// Perform the CCI request and get the result
IAvapiResponse_CCI cciResponse =
cci.Query(
"MSFT",
Const_CCI.CCI_interval.n_1min,
10);
// Printout the results
Console.WriteLine("******** RAW DATA CCI ********");
Console.WriteLine(cciResponse.RawData);
Console.WriteLine("******** STRUCTURED DATA CCI ********");
var data = cciResponse.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("TimeZone: " + data.MetaData.TimeZone);
Console.WriteLine("========================");
Console.WriteLine("========================");
foreach (var technical in data.TechnicalIndicator)
{
Console.WriteLine("CCI: " + technical.CCI);
Console.WriteLine("DateTime: " + technical.DateTime);
Console.WriteLine("========================");
}
}
}
}
}
Complete Example of a Windows Form App: Display the result of a CCI request by using the method QueryAsync (asynchronous request)
using Avapi;
using Avapi.AvapiCCI
using System;
using System.Windows.Forms;
namespace WindowsFormsApp1
{
public partial class Form1 : Form
{
private IAvapiConnection m_connection = AvapiConnection.Instance;
private Int_CCI m_cci;
private IAvapiResponse_CCI m_cciResponse;
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 CCI query object
m_cci = m_connection.GetQueryObject_CCI();
base.OnLoad(e);
}
private async void CCIAsyncButton_Click(object sender, EventArgs e)
{
// Perform the CCI request and get the result
m_cciResponse =
await m_cci.QueryAsync(
"MSFT",
Const_CCI.CCI_interval.n_1min,
10);
// Show the results
resultTextBox.AppendText("******** RAW DATA CCI ********" + "\n");
resultTextBox.AppendText(m_cciResponse.RawData + "\n");
resultTextBox.AppendText("******** STRUCTURED DATA CCI ********" + "\n");
var data = m_cciResponse.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("TimeZone: " + data.MetaData.TimeZone + "\n");
resultTextBox.AppendText("========================" + "\n");
resultTextBox.AppendText("========================" + "\n");
foreach (var technical in data.TechnicalIndicator)
{
resultTextBox.AppendText("CCI: " + technical.CCI + "\n");
resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
resultTextBox.AppendText("========================" + "\n");
}
}
}
}
}