Skip to content

ryroeu/yfinance

 
 

Repository files navigation

Download market data from Yahoo! Finance's API

Python version Star this repo

yfinance offers a Pythonic way to fetch financial & market data from Yahoo!Ⓡ finance.


Important

Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc.

yfinance is not affiliated, endorsed, or vetted by Yahoo, Inc. It's an open-source tool that uses Yahoo's publicly available APIs, and is intended for research and educational purposes.

You should refer to Yahoo!'s terms of use (here, here, and here) **for details on your rights to use the actual data downloaded.

Remember - the Yahoo! finance API is intended for personal use only.**


Main components

  • Ticker: single ticker data
  • Tickers: multiple tickers' data
  • download: download market data for multiple tickers
  • Market: get information about a market
  • WebSocket and AsyncWebSocket: live streaming data
  • Search: quotes and news from search
  • Lookup: ticker symbol lookup
  • Sector and Industry: sector and industry information

Installation

Clone the repository and install in editable mode:

$ git clone https://github.com/ryroeu/yfinance
$ cd yfinance
$ pip install -e .

To run the FastAPI web app, install the optional web dependencies:

$ pip install -e .[web]

App

Run in terminal

python app/main.py

Run in browser

# Install web app dependencies first:
pip install -e .[web]

# Start it with:
uvicorn app.web.app:app --reload

# Then open: 
http://localhost:8000. 

Legal Stuff

yfinance is distributed under the Apache Software License. See the LICENSE.txt file in the release for details.

AGAIN - yfinance is not affiliated, endorsed, or vetted by Yahoo, Inc. It's an open-source tool that uses Yahoo's publicly available APIs, and is intended for research and educational purposes. You should refer to Yahoo!'s terms of use (here, here, and here) for details on your rights to use the actual data downloaded.

About

Fork and Refactor of Yahoo! Finance's API

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 97.4%
  • TypeScript 1.4%
  • CSS 1.1%
  • HTML 0.1%