BarbezDotEu.AlphaVantage 8.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package BarbezDotEu.AlphaVantage --version 8.0.0                

                    
                

            
NuGet\Install-Package BarbezDotEu.AlphaVantage -Version 8.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BarbezDotEu.AlphaVantage" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add BarbezDotEu.AlphaVantage --version 8.0.0                

                    
                

            
#r "nuget: BarbezDotEu.AlphaVantage, 8.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install BarbezDotEu.AlphaVantage as a Cake Addin
#addin nuget:?package=BarbezDotEu.AlphaVantage&version=8.0.0

// Install BarbezDotEu.AlphaVantage as a Cake Tool
#tool nuget:?package=BarbezDotEu.AlphaVantage&version=8.0.0

BarbezDotEu.AlphaVantage

An unofficial, modern, very much work-in-progress client for Alpha Vantage APIs.

The binaries are available as a NuGet package from https://www.nuget.org/packages/BarbezDotEu.AlphaVantage/ or via e.g. Visual Studio's NuGet package manager.

Contents

<a name='T-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration'></a>

AlphaVantageConfiguration type

Namespace

BarbezDotEu.AlphaVantage

Summary

Implements and houses configuration parameters to correctly connect to and communicate with Alpha Vantage's services.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-#ctor-System-String,System-String-'></a>

#ctor(maxCallsPerDay,symbolSearchUrl) constructor

Summary

Constructs a new AlphaVantageConfiguration using given parameters.

Parameters
Name Type Description
maxCallsPerDay System.String The max. number of calls per day before API calls become rate limited by Alpha Vantage.
symbolSearchUrl System.String The fully-qualified URL to use to search for symbols, including the API key. However, omit the actual search symbol.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-#ctor-System-Int64,System-String-'></a>

#ctor(maxCallsPerDay,symbolSearchUrl) constructor

Summary

Constructs a new AlphaVantageConfiguration using given parameters.

Parameters
Name Type Description
maxCallsPerDay System.Int64 The max. number of calls per day before API calls become rate limited by Alpha Vantage.
symbolSearchUrl System.String The fully-qualified URL to use to search for symbols, including the API key. However, omit the actual search symbol.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-#ctor-System-String-'></a>

#ctor(apiKey) constructor

Summary

Constructs a new AlphaVantageConfiguration using all-default settings.

Parameters
Name Type Description
apiKey System.String The API key (to be requested via Alpha Vantage's website prior to using this library).

<a name='P-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-MaxCallsPerDay'></a>

MaxCallsPerDay property

Summary

Gets the maximum number of calls allowed per day.

<a name='P-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-SymbolSearchUrl'></a>

SymbolSearchUrl property

Summary

Gets the fully-qualified URL to use to search for symbols, including the API key. However, omits the actual search symbol.

<a name='T-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider'></a>

AlphaVantageDataProvider type

Namespace

BarbezDotEu.AlphaVantage.AlphaVantage

Summary

Implements a data provider that connects to and can call Alpha Vantage APIs.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider-#ctor-Microsoft-Extensions-Logging-ILogger,System-Net-Http-IHttpClientFactory-'></a>

#ctor(logger,httpClientFactory) constructor

Summary

Constructs a AlphaVantageDataProvider.

Parameters
Name Type Description
logger Microsoft.Extensions.Logging.ILogger A ILogger to use for logging.
httpClientFactory System.Net.Http.IHttpClientFactory The IHttpClientFactory to use.

<a name='P-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider-Configuration'></a>

Configuration property

Summary

Gets the AlphaVantageConfiguration this AlphaVantageDataProvider uses to communicate to the APIs.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider-Configure-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-'></a>

Configure() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider-GetBaseCompanyDataFullyMatching-System-String,System-Boolean,System-Double-'></a>

GetBaseCompanyDataFullyMatching() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

<a name='M-BarbezDotEu-AlphaVantage-AlphaVantage-AlphaVantageDataProvider-GetBaseCompanyDataPartialMatches-System-String,System-Boolean,System-Double-'></a>

GetBaseCompanyDataPartialMatches() method

Summary

Inherit from parent.

Parameters

This method has no parameters.

<a name='T-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch'></a>

BaseCompanyDataFullMatch type

Namespace

BarbezDotEu.AlphaVantage.DTO

Summary

Implements a base company data DTO that EXACTLY matches a query.

<a name='M-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-#ctor-System-String,System-String,System-String,System-String,System-String,System-String,System-String,System-String-'></a>

#ctor(currency,marketClose,marketOpen,name,region,symbol,timeZone,type) constructor

Summary

Constructs a new BaseCompanyDataFullMatch.

Parameters
Name Type Description
currency System.String The currency.
marketClose System.String When the market closes.
marketOpen System.String When the market opens.
name System.String The name of the company.
region System.String The region the company is located in.
symbol System.String The company's ticker symbol.
timeZone System.String The timezone.
type System.String The type.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Currency'></a>

Currency property

Summary

Gets or sets the currency.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-MarketClose'></a>

MarketClose property

Summary

Gets or sets when the market closes.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-MarketOpen'></a>

MarketOpen property

Summary

Gets or sets when the market opens.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Name'></a>

Name property

Summary

Gets or sets the company name.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Region'></a>

Region property

Summary

Gets or sets the region.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Symbol'></a>

Symbol property

Summary

Gets or sets the company's symbol.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Timezone'></a>

Timezone property

Summary

Gets or sets the timezone.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataFullMatch-Type'></a>

Type property

Summary

Gets or sets the type.

<a name='T-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch'></a>

BaseCompanyDataPartialMatch type

Namespace

BarbezDotEu.AlphaVantage.DTO

Summary

Implements a base company data DTO that matches a query either completely, or to a certain extent only.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-Currency'></a>

Currency property

Summary

Gets or sets the currency.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-MarketClose'></a>

MarketClose property

Summary

Gets or sets the market close time.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-MarketOpen'></a>

MarketOpen property

Summary

Gets or sets the market open time.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-MatchScore'></a>

MatchScore property

Summary

Gets or sets a percentage in which the result is a match in the context of a query.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-Name'></a>

Name property

Summary

Gets or sets the company name.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-Region'></a>

Region property

Summary

Gets or sets the region.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-Symbol'></a>

Symbol property

Summary

Gets or sets the symbol.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-TimeZone'></a>

TimeZone property

Summary

Gets or sets the time zone.

<a name='P-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-Type'></a>

Type property

Summary

Gets or sets the type.

<a name='M-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-AsFullMatch'></a>

AsFullMatch() method

Summary

Assumes an therefore returns this BaseCompanyDataPartialMatch is a BaseCompanyDataFullMatch.

Returns

The BaseCompanyDataFullMatch representation of this BaseCompanyDataPartialMatch.

Parameters

This method has no parameters.

<a name='M-BarbezDotEu-AlphaVantage-DTO-BaseCompanyDataPartialMatch-GetMatchScore'></a>

GetMatchScore() method

Summary

Gets the MatchScore as a double.

Returns

The MatchScore as a double.

Parameters

This method has no parameters.

<a name='T-BarbezDotEu-AlphaVantage-Interfaces-IAlphaVantageDataProvider'></a>

IAlphaVantageDataProvider type

Namespace

BarbezDotEu.AlphaVantage.Interfaces

Summary

Defines a blueprint for a data provider that connects to and can call Alpha Vantage APIs.

<a name='M-BarbezDotEu-AlphaVantage-Interfaces-IAlphaVantageDataProvider-Configure-BarbezDotEu-AlphaVantage-AlphaVantageConfiguration-'></a>

Configure(alphaVantageConfiguration) method

Summary

Configures this IAlphaVantageDataProvider so that it can successfully communicate with the Alpha Vantage APIs.

Parameters
Name Type Description
alphaVantageConfiguration BarbezDotEu.AlphaVantage.AlphaVantageConfiguration The AlphaVantageConfiguration to configure this IAlphaVantageDataProvider with.
Remarks

Configuration is required before any APIs can be called.

<a name='M-BarbezDotEu-AlphaVantage-Interfaces-IAlphaVantageDataProvider-GetBaseCompanyDataFullyMatching-System-String,System-Boolean,System-Double-'></a>

GetBaseCompanyDataFullyMatching(symbol,retryOnError,waitingMinutesBeforeRetry) method

Summary

Gets base company data for a given symbol that EXACTLY matches a query. Returns, if exists, a BaseCompanyDataFullMatch DTO containing the first result that is a 100% match. Returns NULL when no 100% match exists, or when no results were returned from the API.

Returns

The requested BaseCompanyDataFullMatch.

Parameters
Name Type Description
symbol System.String The symbol to return data for.
retryOnError System.Boolean Set to TRUE to retry the request, in case the initial request should prove unsuccessful.
waitingMinutesBeforeRetry System.Double The number of minutes to wait before automatically retrying re-sending the request, if the intention is to retry again upon error.

<a name='M-BarbezDotEu-AlphaVantage-Interfaces-IAlphaVantageDataProvider-GetBaseCompanyDataPartialMatches-System-String,System-Boolean,System-Double-'></a>

GetBaseCompanyDataPartialMatches(symbol,retryOnError,waitingMinutesBeforeRetry) method

Summary

Gets base company data DTO that matches a query either completely, or to a certain extent only.

Returns

The requested BaseCompanyDataFullMatches.

Parameters
Name Type Description
symbol System.String The symbol to return data for.
retryOnError System.Boolean Set to TRUE to retry the request, in case the initial request should prove unsuccessful.
waitingMinutesBeforeRetry System.Double The number of minutes to wait before automatically retrying re-sending the request, if the intention is to retry again upon error.

<a name='T-BarbezDotEu-AlphaVantage-DTO-QueryResponse'></a>

QueryResponse type

Namespace

BarbezDotEu.AlphaVantage.DTO

Summary

Implements the query response contract as defined by Alpha Vantage.

<a name='P-BarbezDotEu-AlphaVantage-DTO-QueryResponse-Matches'></a>

Matches property

Summary

Gets or sets the set of BaseCompanyDataPartialMatches returned by the API.

<a name='M-BarbezDotEu-AlphaVantage-DTO-QueryResponse-GetFirstOfDefaultAbsoluteMatch'></a>

GetFirstOfDefaultAbsoluteMatch() method

Summary

Returns, if exists, a BaseCompanyDataFullMatch DTO containing the first result that is a 100% match. Returns NULL when no 100% match exists, or no results are returned.

Returns

The BaseCompanyDataFullMatch equivalent of this QueryResponse.

Parameters

This method has no parameters.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.0 318 4/25/2024
7.0.0 266 11/18/2023
6.0.0 438 8/24/2022
5.0.1 419 5/18/2022
5.0.0 441 3/23/2022
4.0.2 460 1/30/2022
4.0.1 266 1/8/2022
4.0.0 254 1/8/2022
3.0.0 283 1/8/2022
2.2.0 342 9/14/2021
1.0.2 320 6/7/2021
1.0.1 316 6/7/2021
1.0.0 361 5/25/2021