yfinance-cache
Persistent caching wrapper for yfinance module. Intelligent caching, not dumb caching of web requests - only update cache where missing/outdated and new data expected. Idea is to minimise fetch frequency and quantity - Yahoo API officially only cares about frequency, but I'm guessing they also care about server load from scrapers.
Persistent cache stored in your user cache folder:
- Windows = C:/Users/<USER>/AppData/Local/py-yfinance-cache
- Linux = /home/<USER>/.cache/py-yfinance-cache
- MacOS = /Users/<USER>/Library/Caches/py-yfinance-cache
Install
Available via PIP: pip install yfinance_cache
Interface
Interaction almost identical to yfinance
import yfinance_cache as yfc
dat = yfc.Ticker("MSFT")
dat.history(period="1wk")
dat.calendar
# etc
Supported properties and functions on Ticker class:
isin income_stmt analyst_price_targets insider_purchases
history() balance_sheet earnings_estimate insider_roster_holders
history_metadata cashflow earnings_history insider_transactions
info quarterly_income_stmt eps_revisions institutional_holders
options quarterly_balance_sheet eps_trend major_holders
option_chain() quarterly_cashflow growth_estimates mutualfund_holders
news calendar recommendations
get_earnings_dates() recommendations_summary
get_release_dates() revenue_estimate
sustainability
upgrades_downgrades
Price data differences
Other people have implemented price caches, but none adjust cached data for new stock splits or dividends. YFC does. Price can be adjusted for stock splits, dividends, or both:
dat.history(..., adjust_splits=True, adjust_divs=True)
Price repair is force-enabled, to prevent bad Yahoo data corrupting cache. See yfinance Wiki for detail.
Returned table has 2 new columns:
FetchDate= when data was fetchedFinal?=trueif don't expect future fetches to change
Aging
Concept of max age controls when cached data is updated.
If max age time has passed since last fetch then cache is updated.
Value must be Timedelta or equivalent str.
Price data aging
df = dat.history(interval="1d", max_age="1h", trigger_at_market_close=False, ...)
With price data, YFC also considers how long exchange been open since last fetch,
using exchange_calendars.
Only if market been open long enough since last fetch,
or if trigger_at_market_close=True and market since closed,
is cache refreshed.
max_age defaults to half of interval.
Shares aging
df = dat.shares(..., max_age='60d')
Property aging
For data obtained from Ticker properties not functions, max age set in YFC options.
Implemented to behave like pandas.options, except YFC options are persistent.
import yfinance_cache as yfc
print(yfc.options)
{
"max_ages": {
"calendar": "7d",
...
}
}
yfc.options.max_ages.calendar = '30d'
print(yfc.options)
{
"max_ages": {
"calendar": "30d",
...
}
}
Financials
Financials updates are handled different because they don't age.
Instead, YFC analyses earnings dates to determine exactly when next earnings will be,
or if Yahoo data is incomplete then YFC will predict.
You can inspect this schedule in new function dat.get_release_dates().
Offline mode
Disable all web fetches with this special option at top of first script:
import yfinance_cache as yfc
yfc.options.session.offline = True
...
Options in yfc.options.session reset when Python closes.
Verifying cache
Cached prices can be compared against latest Yahoo Finance data, and correct differences:
# Verify prices of one ticker symbol
dat.verify_cached_prices(
rtol=0.0001, # relative tolerance for differences
vol_rtol=0.005, # relative tolerance specifically for Volume
correct=[False|'one'|'all'], # delete incorrect cached data? 'one' = stop after correcting first incorrect prices table ; 'all' = correct all tickers & intervals
discard_old=False, # if cached data too old to check (e.g. 30m), assume incorrect and delete?
quiet=True, # enable to print nothing, disable to print summary detail of why cached data wrong
debug=False, # enable even more detail for debugging
debug_interval=None) # only verify this interval (note: 1d always verified)
# Verify prices of entire cache, ticker symbols processed alphabetically. Recommend using `requests_cache` session.
yfc.verify_cached_tickers_prices(
session=None, # recommend you provide a requests_cache here if debugging
rtol=0.0001,
vol_rtol=0.005,
correct=[False|'one'|'all'],
delist_action=['delete'|'keep'|'raise'], # 'delete'/'keep' delisted tickers from cache, or 'raise' exception when detected
halt_on_fail=True, # stop verifying on first fail
resume_from_tkr=None, # in case you aborted verification, can jump ahead to this ticker symbol. Append '+1' to start AFTER the ticker
debug_tkr=None, # only verify this ticker symbol
debug_interval=None)
These return False if difference detected else True, regardless of if difference was corrected.
-
to scan for first data mismatch but not correct:
yfc.verify_cached_tickers_prices(). -
to fix all data issues:
yfc.verify_cached_tickers_prices(correct='all', halt_on_fail=False)
I hope latest version 0.6.2 fixed the last bugs in applying new dividend-adjustments and splits to cached prices (Adj Close etc).
Only genuine differences in not-adjusted prices are Volume differences (~0.5%) -
Yahoo sometimes changes Volume over 24 hours after that day ended e.g. updating Monday Volume on Wednesday,
sometimes weeks later!
If you see big differences in the OHLC price of recent intervals (last few days), probably Yahoo is wrong. Since fetching that price data on day / day after, Yahoo has messed up their data - at least this is my experience. Cross-check against TradingView or stock exchange website.
Metadata
Release files for yfinance-cache 0.9.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| yfinance_cache-0.9.3.tar.gz | 174.0 kB | Without provenance | Details for yfinance_cache-0.9.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| yfinance_cache-0.9.3-py3-none-any.whl | Python 3 | none | any | Details for yfinance_cache-0.9.3-py3-none-any.whl |
Total release size: 369.8 kB
Release files / yfinance_cache-0.9.3.tar.gz
| Download URL | yfinance_cache-0.9.3.tar.gz |
|---|---|
| Size | 174.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
966c53961fd1ca4162c4d99f0476cd86bf9859d7d89f4621bad2a1c81f936023
|
|
BLAKE2b-256 checksum How to use checksums |
6f0ae5d38087fa4e4a3a1046cbe0268073f2d6b2fab5e8bbda583d1064ec1672
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / yfinance_cache-0.9.3-py3-none-any.whl
| Download URL | yfinance_cache-0.9.3-py3-none-any.whl |
|---|---|
| Size | 195.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9abcab360db9fae34b711415b9e904bfe60de88557656ce00104f5f7051dfd46
|
|
BLAKE2b-256 checksum How to use checksums |
4c86d80ca7f590f4bc67283bda9c105e39403bac7f7c7bbfe1a9ad7fefb423fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Security for yfinance-cache 0.9.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.