Skip to content

Commit adb67b2

Browse files
authored
Merge pull request pydata#823 from lukashalim/master
Adding yahoo finance documentation
2 parents c309574 + 04c7209 commit adb67b2

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-0
lines changed

docs/source/readers/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,4 @@ Data Readers
2121
tiingo
2222
tsp
2323
world-bank
24+
yahoo

docs/source/readers/yahoo.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Yahoo Finance
2+
----------------------------
3+
4+
.. py:module:: pandas_datareader.yahoo.daily
5+
6+
.. autoclass:: YahooDailyReader
7+
:members:
8+
:inherited-members:
9+
10+
.. py:module:: pandas_datareader.yahoo.fx
11+
12+
.. autoclass:: YahooFXReader
13+
:members:
14+
:inherited-members:
15+
16+
.. py:module:: pandas_datareader.yahoo.options
17+
18+
.. autoclass:: Options
19+
:members:
20+
:inherited-members:
21+
22+
.. py:module:: pandas_datareader.yahoo.quotes
23+
24+
.. autoclass:: YahooQuotesReader
25+
:members:
26+
:inherited-members:
27+
28+
.. py:module:: pandas_datareader.yahoo.components
29+
30+
.. autoclass:: _get_data
31+
:members:
32+
:inherited-members:
33+
34+
.. py:module:: pandas_datareader.yahoo.actions
35+
36+
.. autoclass:: YahooActionReader
37+
:members:
38+
:inherited-members:
39+
40+
.. autoclass:: YahooDivReader
41+
:members:
42+
:inherited-members:
43+
44+
.. autoclass:: YahooSplitReader
45+
:members:
46+
:inherited-members:

docs/source/remote_data.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Currently the following sources are supported:
4242
- :ref:`Stooq<remote_data.stooq>`
4343
- :ref:`MOEX<remote_data.moex>`
4444
- :ref:`Naver Finance<remote_data.naver>`
45+
- :ref:`Yahoo Finance<remote_data.yahoo>`
4546

4647
It should be noted, that various sources support different kinds of data, so not all sources implement the same methods and the data elements returned might also differ.
4748

@@ -710,3 +711,31 @@ Naver Finance Data
710711
711712
.. _KOSPI: https://en.wikipedia.org/wiki/KOSPI
712713
.. _KOSDAQ: https://en.wikipedia.org/wiki/KOSDAQ
714+
715+
.. _remote_data.yahoo:
716+
717+
Yahoo Finance Data
718+
==================
719+
`Yahoo Finance provides stock market data
720+
721+
The following endpoints are available:
722+
723+
* ``yahoo`` - retrieve daily stock prices (high, open, close, volu,e and adjusted close)
724+
* ``yahoo-actions`` - retrieve historical corporate actions (dividends and stock splits)
725+
* ``yahoo-dividends`` - retrieve historical dividends
726+
727+
.. ipython:: python
728+
729+
import pandas_datareader.data as web
730+
import pandas as pd
731+
import datetime as dt
732+
df = web.DataReader('GE', 'yahoo', start='2019-09-10', end='2019-10-09')
733+
df.head()
734+
735+
start = dt.datetime(2010, 1, 29)
736+
end = dt.datetime.today()
737+
actions = web.DataReader('GOOG', 'yahoo-actions', start, end)
738+
actions.head()
739+
740+
dividends = web.DataReader('IBM', 'yahoo-dividends', start, end)
741+
dividends.head()
File renamed without changes.

0 commit comments

Comments
 (0)