Skip to content

BBANDS

Jump to bottom
essegisolutions edited this page Jan 13, 2018 · 8 revisions

What BBANDS does?

This API returns the Bollinger bands (BBANDS) values. The related REST API documentation is here

Including the BBANDS namespace

The very first thing to do before diving into BBANDS calls is to include the right namespace.


using Avapi.AvapiBBANDS

How to get a BBANDS object?

The BBANDS 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 BBANDS from it.


...
Int_BBANDS bbands = 
	connection.GetQueryObject_BBANDS();

Perform a BBANDS Synchronous Request

To perform a BBANDS request you have 2 options:

  1. The request with constants:

IAvapiResponse_BBANDS Query(string symbol,
		BBANDS_interval interval,
		int time_period,
		BBANDS_series_type series_type,
		int nbdevup [OPTIONAL],
		int nbdevdn [OPTIONAL],
		BBANDS_matype matype [OPTIONAL]);
  1. The request without constants:

IAvapiResponse_BBANDS QueryPrimitive(string symbol,
		string interval,
		string time_period,
		string series_type,
		string nbdevup [OPTIONAL],
		string nbdevdn [OPTIONAL],
		string matype [OPTIONAL]);

Perform an BBANDS Asynchronous Request

To perform an BBANDS asynchronous request you have 2 options:

  1. The request with constants:

async Task<IAvapiResponse_BBANDS> QueryAsync(string symbol,
		BBANDS_interval interval,
		int time_period,
		BBANDS_series_type series_type,
		int nbdevup [OPTIONAL],
		int nbdevdn [OPTIONAL],
		BBANDS_matype matype [OPTIONAL]);
  1. The request without constants:

async Task<IAvapiResponse_BBANDS> QueryAsync(string symbol,
		string interval,
		string time_period,
		string series_type,
		string nbdevup [OPTIONAL],
		string nbdevdn [OPTIONAL],
		string matype [OPTIONAL]);

Parameters

The parameters below are needed to perform the BBANDS 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 BBANDS value.
  • series_type: The price type in the time series. The types supported are: close, open, high, low
  • nbdevup [OPTIONAL]: The standard deviation multiplier of the upper band. It is a optional value; positive integers are accepted. By default, nbdevup=2
  • nbdevdn [OPTIONAL]: The standard deviation multiplier of the lower band. It is a optional value; positive integers are accepted. By default, nbdevdn=2
  • matype [OPTIONAL]: Moving average type of the time series. It is a optional value; positive integers are accepted. By default, matype=0, check the Alphavantage documentation for the mapping.

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:

  • BBANDS_interval
  • BBANDS_series_type
  • BBANDS_matype

BBANDS_interval: The time interval between two consecutive data points in the time series.


public enum BBANDS_interval
{
	none,
	n_1min,
	n_5min,
	n_15min,
	n_30min,
	n_60min,
	daily,
	weekly,
	monthly
}

BBANDS_series_type: The price type in the time series. The types supported are: close, open, high, low


public enum BBANDS_series_type
{
	none,
	close,
	open,
	high,
	low
}

BBANDS_matype: Moving average type of the time series. It is a optional value; positive integers are accepted. By default, matype=0, check the Alphavantage documentation for the mapping.


public enum BBANDS_matype
{
	none,
	n_0,
	n_1,
	n_2,
	n_3,
	n_4,
	n_5,
	n_6,
	n_7,
	n_8
}

BBANDS Response

The response of a BBANDS request is an object that implements the IAvapiResponse_BBANDS interface.


public interface IAvapiResponse_BBANDS
{
    string RawData
    {
        get;
    }
    IAvapiResponse_BBANDS_Content Data
    {
        get;
    }
}

The IAvapiResponse_BBANDS 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_BBANDS_Content.

Complete Example of a Console App: Display the result of a BBANDS request by using the method Query (synchronous request)


using System;
using System.IO;
using Avapi.AvapiBBANDS;

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 BBANDS query object
            Int_BBANDS bbands =
                connection.GetQueryObject_BBANDS();

            // Perform the BBANDS request and get the result
            IAvapiResponse_BBANDS bbandsResponse = 
            bbands.Query(
                 "MSFT",
                 Const_BBANDS.BBANDS_interval.n_1min,
                 10,
                 Const_BBANDS.BBANDS_series_type.close,
                 10,
                 10,
                 Const_BBANDS.BBANDS_matype.n_0);

            // Printout the results
            Console.WriteLine("******** RAW DATA BBANDS ********");
            Console.WriteLine(bbandsResponse.RawData);

            Console.WriteLine("******** STRUCTURED DATA BBANDS ********");
            var data = bbandsResponse.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("DeviationUpper: " + data.MetaData.DeviationUpper);
                Console.WriteLine("DeviationLower: " + data.MetaData.DeviationLower);
                Console.WriteLine("MAType: " + data.MetaData.MAType);
                Console.WriteLine("SeriesType: " + data.MetaData.SeriesType);
                Console.WriteLine("TimeZone: " + data.MetaData.TimeZone);
                Console.WriteLine("========================");
                Console.WriteLine("========================");
                foreach (var technical in data.TechnicalIndicator)
                {
                    Console.WriteLine("RealLowerBand: " + technical.RealLowerBand);
                    Console.WriteLine("RealUpperBand: " + technical.RealUpperBand);
                    Console.WriteLine("RealMiddleBand: " + technical.RealMiddleBand);
                    Console.WriteLine("DateTime: " + technical.DateTime);
                    Console.WriteLine("========================");
                }
            }
        }
    }
}

Complete Example of a Windows Form App: Display the result of a BBANDS request by using the method QueryAsync (asynchronous request)


using Avapi;
using Avapi.AvapiBBANDS
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        private IAvapiConnection m_connection = AvapiConnection.Instance;
        private Int_BBANDS m_bbands;
        private IAvapiResponse_BBANDS m_bbandsResponse;

        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 BBANDS query object
            m_bbands = m_connection.GetQueryObject_BBANDS();

            base.OnLoad(e);
        }

        private async void BBANDSAsyncButton_Click(object sender, EventArgs e)
        {
            // Perform the BBANDS request and get the result
            m_bbandsResponse = 
                await m_bbands.QueryAsync(
                     "MSFT",
                     Const_BBANDS.BBANDS_interval.n_1min,
                     10,
                     Const_BBANDS.BBANDS_series_type.close,
                     10,
                     10,
                     Const_BBANDS.BBANDS_matype.n_0);

             // Show the results
            resultTextBox.AppendText("******** RAW DATA BBANDS ********" + "\n");
            resultTextBox.AppendText(m_bbandsResponse.RawData + "\n");

            resultTextBox.AppendText("******** STRUCTURED DATA BBANDS ********" + "\n");
            var data = m_bbandsResponse.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("DeviationUpper: " + data.MetaData.DeviationUpper + "\n");
                resultTextBox.AppendText("DeviationLower: " + data.MetaData.DeviationLower + "\n");
                resultTextBox.AppendText("MAType: " + data.MetaData.MAType + "\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("RealLowerBand: " + technical.RealLowerBand + "\n");
                    resultTextBox.AppendText("RealUpperBand: " + technical.RealUpperBand + "\n");
                    resultTextBox.AppendText("RealMiddleBand: " + technical.RealMiddleBand + "\n");
                    resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
                    resultTextBox.AppendText("========================" + "\n");
                }
            }
        }
    }
}

Clone this wiki locally