SAR

What SAR does?

This API returns the parabolic SAR (SAR) values. The related REST API documentation is here

---

Including the SAR namespace

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

using Avapi.AvapiSAR

How to get a SAR object?

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

...
Int_SAR sar = 
	connection.GetQueryObject_SAR();

Perform a SAR Synchronous Request

To perform a SAR request you have 2 options:

1. The request with constants:

IAvapiResponse_SAR Query(string symbol,
		SAR_interval interval,
		float acceleration [OPTIONAL],
		float maximum [OPTIONAL]);

2. The request without constants:

IAvapiResponse_SAR QueryPrimitive(string symbol,
		string interval,
		string acceleration [OPTIONAL],
		string maximum [OPTIONAL]);

Perform an SAR Asynchronous Request

To perform an SAR asynchronous request you have 2 options:

1. The request with constants:

async Task<IAvapiResponse_SAR> QueryAsync(string symbol,
		SAR_interval interval,
		float acceleration [OPTIONAL],
		float maximum [OPTIONAL]);

2. The request without constants:

async Task<IAvapiResponse_SAR> QueryAsync(string symbol,
		string interval,
		string acceleration [OPTIONAL],
		string maximum [OPTIONAL]);

Parameters

The parameters below are needed to perform the SAR request.

• symbol: The name of the equity
• interval: The time interval between two consecutive data points in the time series.
• acceleration [OPTIONAL]: The acceleration factor. It is a optional value; positive float are accepted. By default, acceleration=0.01
• maximum [OPTIONAL]: The maximum value for the accelleration. It is a optional value; positive float are accepted. By default, maximum=0.20

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:

• SAR_interval

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

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

---

SAR Response

The response of a SAR request is an object that implements the IAvapiResponse_SAR interface.

public interface IAvapiResponse_SAR
{
    string RawData
    {
        get;
    }
    IAvapiResponse_SAR_Content Data
    {
        get;
    }
}

The IAvapiResponse_SAR 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_SAR_Content.

---

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

using System;
using System.IO;
using Avapi.AvapiSAR;

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 SAR query object
            Int_SAR sar =
                connection.GetQueryObject_SAR();

            // Perform the SAR request and get the result
            IAvapiResponse_SAR sarResponse = 
            sar.Query(
                 "MSFT",
                 Const_SAR.SAR_interval.n_1min,
                 0.2f,
                 0.2f);

            // Printout the results
            Console.WriteLine("******** RAW DATA SAR ********");
            Console.WriteLine(sarResponse.RawData);

            Console.WriteLine("******** STRUCTURED DATA SAR ********");
            var data = sarResponse.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("Acceleration: " + data.MetaData.Acceleration);
                Console.WriteLine("Maximum: " + data.MetaData.Maximum);
                Console.WriteLine("TimeZone: " + data.MetaData.TimeZone);
                Console.WriteLine("========================");
                Console.WriteLine("========================");
                foreach (var technical in data.TechnicalIndicator)
                {
                    Console.WriteLine("SAR: " + technical.SAR);
                    Console.WriteLine("DateTime: " + technical.DateTime);
                    Console.WriteLine("========================");
                }
            }
        }
    }
}

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

using Avapi;
using Avapi.AvapiSAR
using System;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        private IAvapiConnection m_connection = AvapiConnection.Instance;
        private Int_SAR m_sar;
        private IAvapiResponse_SAR m_sarResponse;

        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 SAR query object
            m_sar = m_connection.GetQueryObject_SAR();

            base.OnLoad(e);
        }

        private async void SARAsyncButton_Click(object sender, EventArgs e)
        {
            // Perform the SAR request and get the result
            m_sarResponse = 
                await m_sar.QueryAsync(
                     "MSFT",
                     Const_SAR.SAR_interval.n_1min,
                     0.2f,
                     0.2f);

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

            resultTextBox.AppendText("******** STRUCTURED DATA SAR ********" + "\n");
            var data = m_sarResponse.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("Acceleration: " + data.MetaData.Acceleration + "\n");
                resultTextBox.AppendText("Maximum: " + data.MetaData.Maximum + "\n");
                resultTextBox.AppendText("TimeZone: " + data.MetaData.TimeZone + "\n");
                resultTextBox.AppendText("========================" + "\n");
                resultTextBox.AppendText("========================" + "\n");
                foreach (var technical in data.TechnicalIndicator)
                {
                    resultTextBox.AppendText("SAR: " + technical.SAR + "\n");
                    resultTextBox.AppendText("DateTime: " + technical.DateTime + "\n");
                    resultTextBox.AppendText("========================" + "\n");
                }
            }
        }
    }
}