Caching wrapper for yfinance module. Intelligent caching, not dumb caching of web requests:
- If requested data not in cache,
yfinance
is called - If all requested data is in cache, return that
- If some in cache but some missing, ask
yfinance
for the missing data
Additional logic decides if cached data needs refresh.
Interaction is almost identical to yfinance. Differences are highlighted underneath code:
import yfinance_cache as yf
msft = yf.Ticker("MSFT")
# get stock info
msft.info
# get historical market data
hist = msft.history(period="max")
...
# etc. See yfinance documentation for full API
msft = yf.Ticker(interval="1d", max_age=datetime.timedelta(hours=1), ...)
max_age
controls when to refresh cached data to avoid spam. If market is still open and max_age
time has passed since last fetch, then today's cached price data will be refreshed.
Defaults to half of interval. Refresh also triggered if market closed since last fetch.
Price can be adjusted for stock splits, dividends, or both. yfinance
only allows control of dividends adjustment via auto_adjust
. How Yahoo adjusts for dividends is slightly mysterious so djusted prices are slightly different to Yahoo (tiny relative error ~1e-7)
msft = yf.Ticker(..., adjust_splits=True, adjust_divs=True)
Available on PIP: pip install yfinance_cache
- Considering adding a 'verify' function, checking all cached data against Yahoo.
- Add refresh check to financials data, then to earnings dates.
Code is being actively developed so some features missing:
- only price data is checked if refresh needed
Tickers
class anddownload()
not available - useTicker.history()
- pre/post price data not available