You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-26Lines changed: 14 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,43 +32,31 @@ Yahoo! finance API is intended for personal use only.**
32
32
<atarget="new"href="https://github.com/ranaroussi/yfinance"><imgborder=0src="https://img.shields.io/github/stars/ranaroussi/yfinance.svg?style=social&label=Star&maxAge=60"alt="Star this repo"></a>
33
33
<atarget="new"href="https://twitter.com/aroussi"><imgborder=0src="https://img.shields.io/twitter/follow/aroussi.svg?style=social&label=Follow&maxAge=60"alt="Follow me on twitter"></a>
34
34
35
+
**yfinance** offers a Pythonic way to fetch financial & market data from [Yahoo!Ⓡ finance](https://finance.yahoo.com).
35
36
36
-
**yfinance** offers a threaded and Pythonic way to download market data from [Yahoo!Ⓡ finance](https://finance.yahoo.com).
37
+
## Main components
37
38
38
-
## Main Features
39
-
-`Ticker` module: Class for accessing single ticker data.
40
-
-`Tickers` module: Class for handling multiple tickers.
41
-
-`download` Efficiently download market data for multiple tickers.
42
-
-`Sector` and `Industry` modules : Classes for accessing sector and industry information.
43
-
- Market Screening: `EquityQuery` and `Screener` to build query and screen the market.
44
-
- Caching and Smart Scraping
39
+
-`Ticker`: single ticker data
40
+
-`Tickers`: multiple tickers' data
41
+
-`download`: download market data for multiple tickers
42
+
-`Sector` and `Industry`: sector and industry information
43
+
-`EquityQuery` and `Screener`: build query to screen market
45
44
46
-
## Documentation
47
-
The official documentation is available on [ranaroussi.github.io/yfinance](https://ranaroussi.github.io/yfinance/index.html)
To install with optional dependencies, replace `optional` with: `nospam` for [caching-requests](#smarter-scraping), `repair` for [price repair](https://github.com/ranaroussi/yfinance/wiki/Price-repair), or `nospam,repair` for both:
The list of changes can be found in the [changelog](https://github.com/ranaroussi/yfinance/blob/main/CHANGELOG.rst)
68
-
55
+
The list of changes can be found in the [Changelog](https://github.com/ranaroussi/yfinance/blob/main/CHANGELOG.rst)
69
56
70
57
## Developers: want to contribute?
71
-
`yfinance` relies on community to investigate bugs and contribute code. Developer guide: https://github.com/ranaroussi/yfinance/discussions/1084
58
+
59
+
`yfinance` relies on community to investigate bugs, review code, and contribute code. Developer guide: https://github.com/ranaroussi/yfinance/discussions/1084
72
60
73
61
---
74
62
@@ -77,7 +65,6 @@ The list of changes can be found in the [changelog](https://github.com/ranarouss
77
65
**yfinance** is distributed under the **Apache Software License**. See
78
66
the [LICENSE.txt](./LICENSE.txt) file in the release for details.
79
67
80
-
81
68
AGAIN - yfinance is **not** affiliated, endorsed, or vetted by Yahoo, Inc. It's
82
69
an open-source tool that uses Yahoo's publicly available APIs, and is
83
70
intended for research and educational purposes. You should refer to Yahoo!'s terms of use
@@ -93,3 +80,4 @@ details on your rights to use the actual data downloaded.
0 commit comments