Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgnsrekt/yfs
Yahoo Finance Scraper with a WYSIWYG approach.
https://github.com/dgnsrekt/yfs
finance scraper scraper-api yahoo
Last synced: 20 days ago
JSON representation
Yahoo Finance Scraper with a WYSIWYG approach.
- Host: GitHub
- URL: https://github.com/dgnsrekt/yfs
- Owner: dgnsrekt
- License: mit
- Created: 2020-09-16T02:10:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-01-19T04:49:51.000Z (almost 4 years ago)
- Last Synced: 2024-10-27T22:36:02.601Z (2 months ago)
- Topics: finance, scraper, scraper-api, yahoo
- Language: HTML
- Homepage: https://dgnsrekt.github.io/yfs/
- Size: 1.36 MB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# YFS
## Yahoo Finance Scraper with a WYSIWYG approach.
[](https://travis-ci.com/dgnsrekt/yfs)
[](https://github.com/psf/black)
[](https://raw.githubusercontent.com/dgnsrekt/yfs/master/LICENSE)
Want to scrape data from the summary page use the get_summary_page function. Want to scrape the summary pages of a list of symbols use the get_multiple_summary_pages function. The returned object can be serialized with .json, .dict, ***and depending on the object .dataframe*** methods. Each function can accept a proxy to help avoid rate limiting. In fact in the future you can install [requests-whaor](https://github.com/dgnsrekt/requests-whaor) ***ANOTHER WORK IN PROGRESS*** which supplies a rotating proxy to bypass rate limits.
***Before you start please note adding historical data to this API is not a priority. At some point I will get around to it. My main focus are options, quote information and symbol lookup. So please do not raise issues about historical data.***
## Features
* [x] Company and Symbol lookup
* [x] Summary Page
* [x] Option Chains
* [x] Statistics Page
## [>> To the documentation.](https://dgnsrekt.github.io/yfs/)
## Quick Start
### Prereqs
* Python ^3.8
### Install with pip
```
pip install yfs
```
### Install with [poetry](https://python-poetry.org/)
```
poetry add yfs
```
### How to scrape multiple summary pages from yahoo finance.
```python
from yfs import get_multiple_summary_pages
search_items = ["Apple", "tsla", "Microsoft", "AMZN"]
summary_results = get_multiple_summary_pages(search_items)
for page in summary_results:
print(page.json(indent=4))
break # To shorten up the quick-start output.
COLUMNS = [
"close",
"change",
"percent_change",
"average_volume",
"market_cap",
"earnings_date",
]
print(summary_results.dataframe[COLUMNS])
```
Output
```python
➜ python3 quick_start_example.py
Downloading Summary Data... 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 4/4 [00:03<00:00, 1.19 symbols/s]{
"symbol": "AAPL",
"name": "Apple Inc.",
"quote": {
"name": "Apple Inc.",
"close": 113.02,
"change": -3.77,
"percent_change": -3.23
},
"open": 112.89,
"high": 112.22,
"low": 115.37,
"close": 113.02,
"change": -3.77,
"percent_change": -3.23,
"previous_close": 116.79,
"bid_price": 112.58,
"bid_size": 800,
"ask_price": 112.77,
"ask_size": 3000,
"fifty_two_week_low": 137.98,
"fifty_two_week_high": 53.15,
"volume": 144711986,
"average_volume": 172065562,
"market_cap": 1933000000000,
"beta_five_year_monthly": 1.28,
"pe_ratio_ttm": 34.29,
"eps_ttm": 3.3,
"earnings_date": "2020-10-28",
"forward_dividend_yield": 0.82,
"forward_dividend_yield_percentage": 0.7,
"exdividend_date": "2020-08-07",
"one_year_target_est": 119.24
}
close change percent_change average_volume market_cap earnings_date
symbol
AAPL 113.02 -3.77 -3.23 172065562 1933000000000 2020-10-28
AMZN 3125.00 -96.26 -2.99 5071692 1565000000000 2020-10-29
MSFT 206.19 -6.27 -2.95 34844893 1560000000000 2020-10-21
TSLA 415.09 -33.07 -7.38 80574089 386785000000 2020-10-21
```
### Next step [fuzzy search examples](https://dgnsrekt.github.io/yfs/examples/fuzzy-search-examples/)
## TODO
* [ ] More testing
* [ ] More Docs
* [ ] More examples
* [ ] [WHAOR](https://github.com/dgnsrekt/requests-whaor) Example
* [ ] Profile Page
* [ ] Financials Page
* [ ] Analysis Page
* [ ] Holders page
* [ ] Sustainability Page
* [ ] Historical Page
* [ ] Chart Page
* [ ] Conversations Page maybe ¯\_(ツ)_/¯
## Contact Information
Telegram = Twitter = Tradingview = Discord = @dgnsrekt
Email = [email protected]