API Documentation — yahoofinance documentation (2024)

Table of Contents
Core Interface¶ Historical Data¶ Balance Sheet¶ Cash Flow¶ Income Statement¶ Asset Profile¶ Additional Config¶

Please note that the API is currently under development and things maychange rapidly!

Core Interface

class yahoofinance.interfaces.IYahooData(locale)[source]

This is the base interface.

Each class in this library inherits implements this interface.

This class is NOT instantiable.

Parameters:locale – a yahoofinance.Locale constant to determine which domain to query from.
to_csv()[source]

Generates a CSV file.

to_dfs()[source]

Generates a dictionary containing pandas.DataFrame.

Historical Data

class yahoofinance.HistoricalPrices(instrument, start_date, end_date, date_format_string='%Y-%m-%d', event='history', frequency='1d', locale='')[source]

Retrieves historical data from Yahoo Finance.

Parameters:
  • instrument – The a stock instrument code to query.
  • start_date – The start date for the query (inclusive).
  • end_date – The end date for the query (inclusive).
  • date_format_string – If start_date or end_date is not a DateTime object,the object passed in (string) will be parsed to the format string. Default: %Y-%m-%d.
  • event – A DataEvent constant to determine what event to query for. Default: DataEvent.HISTORICAL_PRICES.
  • frequency – A DataFrequency constant to determine the interval between records. Default: DataFrequency.DAILY.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

HistoricalPrices object

Return type:

HistoricalPrices

E.g. https://finance.yahoo.com/quote/AAPL/history

Usage:

>>> from yahoofinance import HistoricalPrices>>> req = HistoricalPrices('AAPL')Object<HistoricalPrices>
to_csv(path=None, sep=', ', data_format='raw', csv_dialect='excel')[source]

Generates a CSV file.

Parameters:
  • path – The path to a file location. If it is None, this method returns theCSV as a string.
  • sep – The separator between elements in the new line. NOT USED
  • data_format – A DataFormat constant to determine how the data isexported. NOT USED
  • csv_dialect – The dialect to write the CSV file. See Python in-built csv.
Returns:

None or string

Return type:

None or string

to_dfs(data_format='raw')[source]

Generates a dictionary containing pandas.DataFrame.

Parameters:data_format – A DataFormat constant to determine how the data is exported.NOT USED
Returns:pandas.DataFrame
Return type:pandas.DataFrame

Dictionary keys

Historical Prices

Note: All of the below classes below are experimental and results mayvary significantly as they data is scraped from the website.Use at your own risk!

Balance Sheet

class yahoofinance.BalanceSheet(stock, locale='')[source]

Retrieves annual balance sheet information from Yahoo Finance.

EXPERIMENTAL

See Also
The yfinance package — Tyson's Python TutorialHow to install yfinance in Python | bobbyhadzyfinance Library - A Complete Guide - AlgoTrading101 Blog

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

BalanceSheet object

Return type:

BalanceSheet

E.g. https://finance.yahoo.com/quote/AAPL/balance-sheet

Usage:

>>> from yahoofinance import BalanceSheet>>> req = BalanceSheet('AAPL')Object<BalanceSheet>
to_csv(path=None, sep=', ', data_format='raw', csv_dialect='excel')[source]

Generates a CSV file.

Parameters:
  • path – The path to a file location. If it is None, this method returns theCSV as a string.
  • sep – The separator between elements in the new line.
  • data_format – A DataFormat constant to determine how the data isexported.
  • csv_dialect – The dialect to write the CSV file. See Python in-built csv.
Returns:

None or string

Return type:

None or string

to_dfs(data_format='raw')[source]

Generates a dictionary containing pandas.DataFrame.

Parameters:data_format – A DataFormat constant to determine how the data is exported.
Returns:pandas.DataFrame
Return type:pandas.DataFrame

Dictionary keys

Cash FlowOverallOperating activitiesInvestment activitiesFinancing activitiesChanges in Cash
class yahoofinance.BalanceSheetQuarterly(stock, locale='')[source]

Retrieves quarterly balance sheet information from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

BalanceSheetQuarterly object

Return type:

BalanceSheetQuarterly

E.g. https://finance.yahoo.com/quote/AAPL/balance-sheet

Usage:

>>> from yahoofinance import BalanceSheetQuarterly>>> req = BalanceSheetQuarterly('AAPL')Object<BalanceSheetQuarterly>

Cash Flow

class yahoofinance.CashFlow(stock, locale='')[source]

Retrieves annual cash flow information from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

CashFlow object

Return type:

CashFlow

E.g. https://finance.yahoo.com/quote/AAPL/cash-flow

Usage:

>>> from yahoofinance import CashFlow>>> req = CashFlow('AAPL')Object<CashFlow>
to_csv(path=None, sep=', ', data_format='raw', csv_dialect='excel')[source]

Generates a CSV file.

Parameters:
  • path – The path to a file location. If it is None, this method returns theCSV as a string.
  • sep – The separator between elements in the new line.
  • data_format – A DataFormat constant to determine how the data isexported.
  • csv_dialect – The dialect to write the CSV file. See Python in-built csv.
Returns:

None or string

Return type:

None or string

to_dfs(data_format='raw')[source]

Generates a dictionary containing pandas.DataFrame.

Parameters:data_format – A DataFormat constant to determine how the data is exported.
Returns:pandas.DataFrame
Return type:pandas.DataFrame

Dictionary keys

Cash FlowOverallOperating activitiesInvestment activitiesFinancing activitiesChanges in Cash
class yahoofinance.CashFlowQuarterly(stock, locale='')[source]

Retrieves quarterly cash flow information from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

CashFlowQuarterly object

Return type:

CashFlowQuarterly

E.g. https://finance.yahoo.com/quote/AAPL/cash-flow

Usage:

>>> from yahoofinance import CashFlowQuarterly>>> req = CashFlowQuarterly('AAPL')Object<CashFlowQuarterly>

Income Statement

class yahoofinance.IncomeStatement(stock, locale='')[source]

Retrieves annual balance sheet information from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

IncomeStatement object

Return type:

IncomeStatement

E.g. https://finance.yahoo.com/quote/AAPL/financials

Usage:

>>> from yahoofinance import IncomeStatement>>> req = IncomeStatement('AAPL')Object<IncomeStatement>
to_csv(path=None, sep=', ', data_format='raw', csv_dialect='excel')[source]

Generates a CSV file.

Parameters:
  • path – The path to a file location. If it is None, this method returns theCSV as a string.
  • sep – The separator between elements in the new line.
  • data_format – A DataFormat constant to determine how the data isexported.
  • csv_dialect – The dialect to write the CSV file. See Python in-built csv.
Returns:

None or string

Return type:

None or string

to_dfs(data_format='raw')[source]

Generates a dictionary containing pandas.DataFrame.

Parameters:data_format – A DataFormat constant to determine how the data is exported.
Returns:pandas.DataFrame
Return type:pandas.DataFrame

Dictionary keys

Cash FlowOverallOperating activitiesInvestment activitiesFinancing activitiesChanges in Cash
class yahoofinance.IncomeStatementQuarterly(stock, locale='')[source]

Retrieves quarterly balance sheet information from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The a stock code to query.
  • locale – A Locale constant to determine which domain to query from. Default: Locale.US.
Returns:

IncomeStatementQuarterly object

Return type:

IncomeStatementQuarterly

E.g. https://finance.yahoo.com/quote/AAPL/financials

Usage:

>>> from yahoofinance import IncomeStatementQuarterly>>> req = IncomeStatementQuarterly('AAPL')Object<IncomeStatementQuarterly>

Asset Profile

class yahoofinance.AssetProfile(stock, locale='')[source]

Retrieves the asset profile from Yahoo Finance.

EXPERIMENTAL

Parameters:
  • stock – The stock ticker
  • locale – A Local constant to determine which domain to query from. Default: Locale.US.
Returns:

AssetProfile object

Return type:

AssetProfile

E.g. https://finance.yahoo.com/quote/AAPL/profile

Usage:

>>> from yahoofinance import AssetProfile>>> req = AssetProfile('AAPL')Object<AssetProfile>
to_csv(path, sep=', ', data_format='raw', csv_dialect='excel')[source]

Generates a CSV file.

Parameters:
  • path – The path to a file location. If it is None, this method returns theCSV as a string.
  • sep – The separator between elements in the new line. NOT USED
  • data_format – A DataFormat constant to determine how the data isexported. NOT USED
  • csv_dialect – The dialect to write the CSV file. See Python in-built csv.
Returns:

None or string

Return type:

None or string

to_dfs(data_format='raw')[source]

Generates a dictionary containing pandas.DataFrame.

Additional Config

class yahoofinance.Locale[source]

Provides locale information to any IYahooData implementations.

By using your local domain, it may speed up queries by a miniscule amount or bypass
certain country domain filters and restrictions.
AU = 'au'

Uses the Australian domain. E.g. https://au.finance.yahoo.com/quote/AAPL/

CA = 'ca'

Uses the Canadian domain. E.g. https://ca.finance.yahoo.com/quote/AAPL/

US = ''

Uses the United States domain. E.g. https://finance.yahoo.com/quote/AAPL/

static locale_url(locale)[source]

This is an auxilary method to determine the domain url for a locale.

Parameters:locale – A Locale string constant. A hard coded string can also be usedif the 2 letter domain is known.
Returns:string object
Return type:string
class yahoofinance.DataEvent[source]

Provides data event information for HistoricalData.

Yahoo provides 3 different types of historical data sets.

class yahoofinance.DataFrequency[source]

Provides data frequency information for HistoricalData.

Yahoo provides data at 3 different time granuarities.

DAILY = '1d'

Retrieve data at daily intervals.

MONTHLY = '1mo'

Retrieve data at montly intervals.

WEEKLY = '1wk'

Retrieve data at weekly intervals.

class yahoofinance.DataFormat[source]

Selects the way data is formatted for IYahooData implementations.

LONG = 'longFmt'

Provides a longer formatted value. E.g. 1,000,000.0

RAW = 'raw'

Provides a raw numerical value. E.g. 1000000.0

SHORT = 'fmt'

Provides a shorter formatted value. E.g. 1.0M

API Documentation — yahoofinance documentation (2024)
Top Articles
Walgreens On Bingle And Long Point
Magic: The Gathering Arena
Spasa Parish
Rentals for rent in Maastricht
159R Bus Schedule Pdf
Sallisaw Bin Store
Black Adam Showtimes Near Maya Cinemas Delano
Espn Transfer Portal Basketball
Pollen Levels Richmond
11 Best Sites Like The Chive For Funny Pictures and Memes
Things to do in Wichita Falls on weekends 12-15 September
Craigslist Pets Huntsville Alabama
Paulette Goddard | American Actress, Modern Times, Charlie Chaplin
What's the Difference Between Halal and Haram Meat & Food?
R/Skinwalker
Rugged Gentleman Barber Shop Martinsburg Wv
Jennifer Lenzini Leaving Ktiv
Justified - Streams, Episodenguide und News zur Serie
Epay. Medstarhealth.org
Olde Kegg Bar & Grill Portage Menu
Cubilabras
Half Inning In Which The Home Team Bats Crossword
Amazing Lash Bay Colony
Juego Friv Poki
Dirt Devil Ud70181 Parts Diagram
Truist Bank Open Saturday
Water Leaks in Your Car When It Rains? Common Causes & Fixes
What’s Closing at Disney World? A Complete Guide
New from Simply So Good - Cherry Apricot Slab Pie
Drys Pharmacy
Ohio State Football Wiki
Find Words Containing Specific Letters | WordFinder®
FirstLight Power to Acquire Leading Canadian Renewable Operator and Developer Hydromega Services Inc. - FirstLight
Webmail.unt.edu
2024-25 ITH Season Preview: USC Trojans
Metro By T Mobile Sign In
Restored Republic December 1 2022
12 30 Pacific Time
Jami Lafay Gofundme
Litter-Robot 3 Pinch Contact & Dfi Kit
Greenbrier Bunker Tour Coupon
No Compromise in Maneuverability and Effectiveness
Black Adam Showtimes Near Cinemark Texarkana 14
Ice Hockey Dboard
Über 60 Prozent Rabatt auf E-Bikes: Aldi reduziert sämtliche Pedelecs stark im Preis - nur noch für kurze Zeit
Wie blocke ich einen Bot aus Boardman/USA - sellerforum.de
Infinity Pool Showtimes Near Maya Cinemas Bakersfield
Dermpathdiagnostics Com Pay Invoice
How To Use Price Chopper Points At Quiktrip
Maria Butina Bikini
Busted Newspaper Zapata Tx
Latest Posts
Flu Shot Appointment Safeway
Adrianne Palicki Wikifeet
Article information

Author: Zonia Mosciski DO

Last Updated:

Views: 5541

Rating: 4 / 5 (71 voted)

Reviews: 94% of readers found this page helpful

Author information

Name: Zonia Mosciski DO

Birthday: 1996-05-16

Address: Suite 228 919 Deana Ford, Lake Meridithberg, NE 60017-4257

Phone: +2613987384138

Job: Chief Retail Officer

Hobby: Tai chi, Dowsing, Poi, Letterboxing, Watching movies, Video gaming, Singing

Introduction: My name is Zonia Mosciski DO, I am a enchanting, joyous, lovely, successful, hilarious, tender, outstanding person who loves writing and wants to share my knowledge and understanding with you.