karlwancl / yahoofinanceapi

A handy Yahoo! Finance api wrapper, based on .NET Standard 2.0

YahooFinanceApi

A handy Yahoo! Finance api wrapper, based on .NET Standard 2.0

Features

• Get quotes
• Get historical data
• Get dividend data
• Get stock split data

Notes

This library is intended for personal use only, any improper use of this library is not recommended.

Install Note

For traditional .NET framework user, if you find a "System.Runtime.Serialization.Primitives" missing exception is thrown when using this library, you have to install the missing package manually as nuget does not auto install this reference for you (Bugged?)

Important Note (2017/11/12)

As Yahoo has terminated their csv quote service, the depending GetAsync method is no longer usable. Please consider using QueryAsync method instead.

v2.2 Changes (2023/05/29) (by sergemat)

• Changed approach for getting auth cookie

• Added cookie authorization to all v7 APIs

• Upgraded all Nuget packages to most recent version and updated all code to work

• Updated tests project to .NET 6

• Added QueryAsync as a replacement of the original GetAsync method

• Added Fields for QueryAsync method

v2.1 Changes (2017/11/12) (Great thanks again to @dshe :D)

• GetAsync method is obsoleted since Yahoo has terminated their csv quote service
• Added QueryAsync as a replacement of the original GetAsync method
• Added Fields for QueryAsync method

v2.0 Changes (2017/10/28) (Great thanks for PRs from @dshe :D)

• Removed error-proned timezone support
• All api call now reads and returns datetime in EST instead of local timezone.
• Removed ascending, leaveZeroWhenInvalid parameter in historical api call.
• IgnoreEmptyRows property in replacement with the original leaveZeroIfInvalid parameter.
• Performance boost on async calls.

Supported Platforms

• .NET Core 2.0
• .NET framework 4.6.1 or above
• Xamarin.iOS
• Xamarin.Android
• Universal Windows Platform

How To Install

You can find the package through Nuget

PM> Install-Package YahooFinanceApi

How To Use

Add reference

using YahooFinanceApi;

Get stock quotes

// You could query multiple symbols with multiple fields through the following steps:
var securities = await Yahoo.Symbols("AAPL", "GOOG").Fields(Field.Symbol, Field.RegularMarketPrice, Field.FiftyTwoWeekHigh).QueryAsync();
var aapl = securities["AAPL"];
var price = aapl[Field.RegularMarketPrice] // or, you could use aapl.RegularMarketPrice directly for typed-value

Supported fields for stock quote

|||||| |--|--|--|--|--|--| | Language | QuoteType | QuoteSourceName | Currency | MarketState | RegularMarketPrice | | RegularMarketTime | RegularMarketChange | RegularMarketOpen | RegularMarketDayHigh | RegularMarketDayLow | RegularMarketVolume | | ShortName | FiftyTwoWeekHighChange | FiftyTwoWeekHighChangePercent | FiftyTwoWeekLow | FiftyTwoWeekHigh | DividendDate | | EarningsTimestamp | EarningsTimestampStart | EarningsTimestampEnd | TrailingAnnualDividendRate | TrailingPE | TrailingAnnualDividendYield | | EpsTrailingTwelveMonths | EpsForward | SharesOutstanding | BookValue | RegularMarketChangePercent | RegularMarketPreviousClose | | Bid | Ask | BidSize | AskSize | MessageBoardId | FullExchangeName | | LongName | FinancialCurrency | AverageDailyVolume3Month | AverageDailyVolume10Day | FiftyTwoWeekLowChange | FiftyTwoWeekLowChangePercent | | TwoHundredDayAverageChangePercent | MarketCap | ForwardPE | PriceToBook | SourceInterval | ExchangeTimezoneName | | ExchangeTimezoneShortName | Market | Exchange | ExchangeDataDelayedBy | PriceHint | FiftyDayAverage | | FiftyDayAverageChange | FiftyDayAverageChangePercent | TwoHundredDayAverage | TwoHundredDayAverageChange | Tradeable | GmtOffSetMilliseconds | | Symbol |||||

Ignore invalid rows

// Sometimes, yahoo returns broken rows for historical calls, you could decide if these invalid rows is ignored or not by the following statement
Yahoo.IgnoreEmptyRows = true;

Get historical data for a stock

// You should be able to query data from various markets including US, HK, TW
// The startTime & endTime here defaults to EST timezone
var history = await Yahoo.GetHistoricalAsync("AAPL", new DateTime(2016, 1, 1), new DateTime(2016, 7, 1), Period.Daily);

foreach (var candle in history)
{
    Console.WriteLine($"DateTime: {candle.DateTime}, Open: {candle.Open}, High: {candle.High}, Low: {candle.Low}, Close: {candle.Close}, Volume: {candle.Volume}, AdjustedClose: {candle.AdjustedClose}");
}

Get dividend history for a stock

// You should be able to query data from various markets including US, HK, TW
var dividends = await Yahoo.GetDividendsAsync("AAPL", new DateTime(2016, 1, 1), new DateTime(2016, 7, 1));
foreach (var candle in dividends)
{
    Console.WriteLine($"DateTime: {candle.DateTime}, Dividend: {candle.Dividend}");
}

Get stock split history for a stock

var splits = await Yahoo.GetSplitsAsync("AAPL", new DateTime(2014, 6, 8), new DateTime(2014, 6, 10));
foreach (var s in splits)
{
    Console.WriteLine($"DateTime: {s.DateTime}, AfterSplit: {s.AfterSplit}, BeforeSplit: {s.BeforeSplit}");
}

Powered by

• Flurl (@tmenier) - A simple & elegant fluent-style REST api library