Skip to content

Commit 2081dca

Browse files
authored
Merge pull request #2992 from TTNAN/docs/adj-close-note-860
docs: explain default price adjustment and Close vs Adj Close (fixes #860)
2 parents 5cae563 + 92079cc commit 2081dca

3 files changed

Lines changed: 17 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@
4545
- `Sector` and `Industry`: sector and industry information
4646
- `EquityQuery` and `Screener`: build query to screen market
4747

48+
> [!NOTE]
49+
> [Prices are default adjusted for dividends (`auto_adjust=True`)](https://ranaroussi.github.io/yfinance/advanced/price_adjustment.html).
50+
4851
## Installation
4952

5053
Install `yfinance` from PYPI using `pip`:

‎doc/source/advanced/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Advanced
1010
config
1111
caching
1212
multi_level_columns
13-
price_repair
13+
price_repair
14+
price_adjustment
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
****************
2+
Price adjustment
3+
****************
4+
5+
By default, ``Ticker.history()`` and ``yf.download()`` return prices **adjusted for splits and dividends** (``auto_adjust=True``). This means the ``Close`` column is already the *adjusted* close — there is no separate ``Adj Close`` column in this mode.
6+
7+
Pass ``auto_adjust=False`` to get Yahoo's split-adjusted OHLC together with an ``Adj Close`` column that also includes dividends.
8+
9+
In other words:
10+
11+
- ``auto_adjust=True`` (default): ``Open``, ``High``, ``Low`` and ``Close`` are all adjusted for splits *and* dividends — the prices you want for total-return-consistent calculations such as backtesting.
12+
- ``auto_adjust=False``: Yahoo's OHLC as returned (already split-adjusted) plus an ``Adj Close`` column that additionally accounts for dividends.

0 commit comments

Comments
 (0)