https://github.com/michaelcurrin/yahoo-finance-reports

Use the Yahoo Finance API to get info on shares of interest and report on them
https://github.com/michaelcurrin/yahoo-finance-reports

data-analysis data-science python reporting shares stock-market yahoo-finance yahoo-finance-api

Last synced: 4 days ago
JSON representation

Use the Yahoo Finance API to get info on shares of interest and report on them

• Host: GitHub
• URL: https://github.com/michaelcurrin/yahoo-finance-reports
• Owner: MichaelCurrin
• License: mit
• Created: 2022-03-13T07:34:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-06-10T08:38:29.000Z (over 2 years ago)
• Last Synced: 2024-10-11T19:36:34.767Z (about 1 month ago)
• Topics: data-analysis, data-science, python, reporting, shares, stock-market, yahoo-finance, yahoo-finance-api
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yahoo Finance Reports

> Use the Yahoo Finance API to get info on stocks of interest and report on them

[![Made with Python](https://img.shields.io/badge/Python->=3.6-blue?logo=python&logoColor=white)](https://python.org "Go to Python homepage")

[![dependency - requests](https://img.shields.io/badge/dependency-requests-blue)](https://pypi.org/project/requests)

## Yahoo Finance and the API

Yahoo has a Finance section on their website for info on stock prices. 

- https://finance.yahoo.com/

They make this data available via a free public API - no auth needed.

For help on using the Yahoo API endpoints, see the SyncWith tool:

- https://syncwith.com/api/yahoo-finance/all-endpoints

That interface lets you build and execute queries in the browser, showing your URLs and sample output.

This project uses the _quote endpoint_ to get detailed info on stocks and the _chart endpoint_ for a timeline of values.

## Installation

Install Python 3 - see [Gist](https://gist.github.com/MichaelCurrin/57caae30bd7b0991098e9804a9494c23).

Create a virtual environment:

```sh

$ python -m venv venv

```

Activate it:

```sh

$ source venv/bin/activate

```

Install packages into it:

```sh

$ make install

```

## Usage

Update [config.py](/app/config.py) for custom stock ticker values. _You have to edit the file directly, but as a follow-up a config file outside of version control will be supported later._

Run the reports:

```sh

$ make run

```

See output CSVs written to [app/var](/app/var).

You can then put those in Google Sheets or Google Data Studio to make your graphs. Or try a Python or JS-based graphing solution.

## License

Licensed under [MIT](/LICENSE) by [MichaelCurrin](https://github.com/MichaelCurrin).