yfinance for Google Sheets

A Yahoo Finance API Custom Function for Google sheets. This function can return any data or statistics for yahoo finance stocks, bonds, funds, and ETFs.

Contents

• =yfinance usage & modules
• =yfinance_history usage

Installation

1. on your sheet go to tools -> Script Editor
2. Create new script and copy yfinance.gs to it
3. Once saved it should be ready for use

Usage (=yfinance) <a name="yf"></a>

Ticker

the ticker according to yahoo finance of the stock you want to get data from Example: "AAPL", "TD.TO"

• =yfinance(ticker,modules,header)
• =yfinance("AAPL","{'assetProfile':[]}",true)

Modules

Every stock has modules of data returned by yahoo finance Each module has submodules (ex. peRatio) and you can specify these in an array or leave an empty [] array to return all submodules returning all submodules may mess up formatting slightly Format: "{'module1':['subModule1','subModule2'], 'module2':[]}" (DONT use doublequotes for modules and submodules)

• =yfinance("AAPL","{'price':['marketCap'],'earnings':[]}",false)

Headers

Include data headers using true/false

• =Yfinance(ticker,modules,true)

Note

not all stocks contain the same modules/submodules so formatting errors may occur due to this. Some submodules have their own submodules (ex. insiderTransactions) which will be put as a JSON string in a cell and may by over the max cell char limit of google sheets.

<h1> Module List / Submodule List</h1> <details><summary>Expand List</summary> NOTE: Some submodules may not be listed <details><summary>assetProfile </summary>

• address1
• city
• state
• zip
• country
• phone
• website
• industry
• sector
• longBusinessSummary
• fullTimeEmployees
• companyOfficers
• auditRisk
• boardRisk
• compensationRisk
• shareHolderRightsRisk
• overallRisk
• governanceEpochDate
• compensationAsOfEpochDate
• maxAge
• address2
• fax

</details><details><summary>recommendationTrend</summary>

• trend
• maxAge

</details><details><summary> cashflowStatementHistory</summary>

• cashflowStatements
• maxAge

</details><details><summary> indexTrend</summary>

• maxAge
• symbol
• peRatio
• pegRatio
• estimates

</details><details><summary> defaultKeyStatistics</summary>

• maxAge
• priceHint
• enterpriseValue
• forwardPE
• profitMargins
• floatShares
• sharesOutstanding
• sharesShort
• sharesShortPriorMonth
• sharesShortPreviousMonthDate
• dateShortInterest
• sharesPercentSharesOut
• heldPercentInsiders
• heldPercentInstitutions
• shortRatio
• shortPercentOfFloat
• beta
• impliedSharesOutstanding
• morningStarOverallRating
• morningStarRiskRating
• category
• bookValue
• priceToBook
• annualReportExpenseRatio
• ytdReturn
• beta3Year
• totalAssets
• yield
• fundFamily
• fundInceptionDate
• legalType
• threeYearAverageReturn
• fiveYearAverageReturn
• priceToSalesTrailing12Months
• lastFiscalYearEnd
• nextFiscalYearEnd
• mostRecentQuarter
• earningsQuarterlyGrowth
• revenueQuarterlyGrowth
• netIncomeToCommon
• trailingEps
• forwardEps
• pegRatio
• lastSplitFactor
• lastSplitDate
• enterpriseToRevenue
• enterpriseToEbitda
• 52WeekChange
• SandP52WeekChange
• lastDividendValue
• lastDividendDate
• lastCapGain
• annualHoldingsTurnover

</details><details><summary> industryTrend</summary>

• maxAge
• symbol
• peRatio
• pegRatio
• estimates

</details><details><summary> quoteType</summary>

• exchange
• quoteType
• symbol
• underlyingSymbol
• shortName
• longName
• firstTradeDateEpochUtc
• timeZoneFullName
• timeZoneShortName
• uuid
• messageBoardId
• gmtOffSetMilliseconds
• maxAge

</details><details><summary> incomeStatementHistory</summary>

• incomeStatementHistory
• maxAge

</details><details><summary> fundOwnership</summary>

• maxAge
• ownershipList

</details><details><summary> summaryDetail</summary>

• maxAge
• priceHint
• previousClose
• open
• dayLow
• dayHigh
• regularMarketPreviousClose
• regularMarketOpen
• regularMarketDayLow
• regularMarketDayHigh
• dividendRate
• dividendYield
• exDividendDate
• payoutRatio
• fiveYearAvgDividendYield
• beta
• trailingPE
• forwardPE
• volume
• regularMarketVolume
• averageVolume
• averageVolume10days
• averageDailyVolume10Day
• bid
• ask
• bidSize
• askSize
• marketCap
• yield
• ytdReturn
• totalAssets
• expireDate
• strikePrice
• openInterest
• fiftyTwoWeekLow
• fiftyTwoWeekHigh
• priceToSalesTrailing12Months
• fiftyDayAverage
• twoHundredDayAverage
• trailingAnnualDividendRate
• trailingAnnualDividendYield
• navPrice
• currency
• fromCurrency
• toCurrency
• lastMarket
• volume24Hr
• volumeAllCurrencies
• circulatingSupply
• algorithm
• maxSupply
• startDate
• tradeable

</details><details><summary> insiderHolders</summary>

• holders
• maxAge

</details><details><summary> calendarEvents</summary>

• maxAge
• earnings
• exDividendDate
• dividendDate

</details><details><summary> upgradeDowngradeHistory</summary>

• history
• maxAge

</details><details><summary> price</summary>

• maxAge
• preMarketChangePercent
• preMarketChange
• preMarketTime
• preMarketPrice
• preMarketSource
• postMarketChange
• postMarketPrice
• regularMarketChangePercent
• regularMarketChange
• regularMarketTime
• priceHint
• regularMarketPrice
• regularMarketDayHigh
• regularMarketDayLow
• regularMarketVolume
• averageDailyVolume10Day
• averageDailyVolume3Month
• regularMarketPreviousClose
• regularMarketSource
• regularMarketOpen
• strikePrice
• openInterest
• exchange
• exchangeName
• exchangeDataDelayedBy
• marketState
• quoteType
• symbol
• underlyingSymbol
• shortName
• longName
• currency
• quoteSourceName
• currencySymbol
• fromCurrency
• toCurrency
• lastMarket
• volume24Hr
• volumeAllCurrencies
• circulatingSupply
• marketCap

</details><details><summary> balanceSheetHistory</summary>

• balanceSheetStatements
• maxAge

</details><details><summary> earningsTrend</summary>

• trend
• maxAge

</details><details><summary> secFilings</summary>

• filings
• maxAge

</details><details><summary> institutionOwnership</summary>

• maxAge
• ownershipList

</details><details><summary> majorHoldersBreakdown</summary>

• maxAge
• insidersPercentHeld
• institutionsPercentHeld
• institutionsFloatPercentHeld
• institutionsCount

</details><details><summary> balanceSheetHistoryQuarterly</summary>

• balanceSheetStatements
• maxAge

</details><details><summary> earningsHistory</summary>

• history
• maxAge

</details><details><summary> majorDirectHolders</summary>

• holders
• maxAge

</details><details><summary> summaryProfile</summary>

• address1
• city
• state
• zip
• country
• phone
• website
• industry
• sector
• longBusinessSummary
• fullTimeEmployees
• companyOfficers
• maxAge
• address2
• fax

</details><details><summary> netSharePurchaseActivity</summary>

• maxAge
• period
• buyInfoCount
• buyInfoShares
• buyPercentInsiderShares
• sellInfoCount
• sellInfoShares
• sellPercentInsiderShares
• netInfoCount
• netInfoShares
• netPercentInsiderShares
• totalInsiderShares

</details><details><summary> insiderTransactions</summary>

• transactions
• maxAge

</details><details><summary> sectorTrend</summary>

• maxAge
• symbol
• peRatio
• pegRatio
• estimates

</details><details><summary> incomeStatementHistoryQuarterly</summary>

• incomeStatementHistory
• maxAge

</details><details><summary> cashflowStatementHistoryQuarterly</summary>

• cashflowStatements
• maxAge

</details><details><summary> earnings</summary>

• maxAge
• earningsChart
• financialsChart
• financialCurrency

</details><details><summary> financialData</summary>

• maxAge
• currentPrice
• targetHighPrice
• targetLowPrice
• targetMeanPrice
• targetMedianPrice
• recommendationMean
• recommendationKey
• numberOfAnalystOpinions
• totalCash
• totalCashPerShare
• ebitda
• totalDebt
• quickRatio
• currentRatio
• totalRevenue
• debtToEquity
• revenuePerShare
• returnOnAssets
• returnOnEquity
• grossProfits
• freeCashflow
• operatingCashflow
• earningsGrowth
• revenueGrowth
• grossMargins
• ebitdaMargins
• operatingMargins
• profitMargins
• financialCurrency

</details><details><summary> fundProfile</summary>

• maxAge
• styleBoxUrl
• family
• categoryName
• legalType
• managementInfo
• feesExpensesInvestment
• feesExpensesInvestmentCat
• initInvestment
• initIraInvestment
• initAipInvestment
• subseqInvestment
• subseqIraInvestment
• subseqAipInvestment
• brokerages

</details><details><summary> topHoldings</summary>

• maxAge
• cashPosition
• stockPosition
• bondPosition
• otherPosition
• preferredPosition
• convertiblePosition
• holdings
• equityHoldings
• bondHoldings
• bondRatings
• sectorWeightings

</details><details><summary> fundPerformance</summary>

• maxAge
• performanceOverview
• performanceOverviewCat
• trailingReturns
• trailingReturnsNav
• trailingReturnsCat
• annualTotalReturns
• pastQuarterlyReturns
• riskOverviewStatistics
• riskOverviewStatisticsCat

</details></details>

Usage (=yfinance_history)<a name="yfh"></a>

Ticker

the ticker according to yahoo finance of the stock you want to get data from Example: "AAPL", "TD.TO"

Interval

the interval between data points returned One of:

• "1m", "2m", "5m", "15m", "30m", "60m", "90m", "1h", "1d", "5d", "1wk", "1mo", "3mo"

Period1/2

period 1 is the start date for data returned and period 2 is the end date Date Format: YYYY-MM-DD Date format w/ time: YYYY-MM-DDTHH-MM-SS (don't change T)

Events

the stock events you want historical data on Format: Array "['dividends','splits']"

• dividends
• capitalGain
• splits

Header

Show headers for data true/false

Formula Examples

Costco Quarterly w/ Dividends:

• =yfinance_history("COST","3mo","2000-01-01","2021-01-01","['dividends']",true)

Tesla Price on 2018-01-10

• =yfinance_history("TSLA","1d","2018-01-10","2018-01-11","[]",false)