yfinance README

The project's README from github.com/ranaroussi/yfinance. As one markdown file: README.md.

Download market data from Yahoo! Finance's API

Python version PyPi version PyPi status PyPi downloads Star this repo Follow me on twitter

ranaroussi%2Fyfinance | Trendshift

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.**


[!TIP] THE NEW DOCUMENTATION WEBSITE IS NOW LIVE! 🤘

Visit ranaroussi.github.io/yfinance


Main components

Installation

Install yfinance from PYPI using pip:

$ pip install yfinance

To install without curl_cffi for requests fallback, see Advanced ▸ Installation.

yfinance relies on the community to investigate bugs and contribute code. Here's how you can help.


Star History Chart


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.


P.S.

Please drop me a note with any feedback you have.

Ran Aroussi

yfinance (ranaroussi/yfinance)

Searching Database…

25.6K ·GitHub
Что это такое?yfinance — это библиотека для Python, которая скачивает финансовые и рыночные данные из API Yahoo! Finance — котировки акций, потоковые данные в реальном времени, поиск и скрининговые запросы — прямо из вашего кода на Python.
Это библиотека, которую я импортирую в свой код, или облачный сервис?Это библиотека для Python: вы устанавливаете её с PyPI и вызываете в своём коде. Никакой сервер или приложение запускать не нужно.
Как добавить её в проект?Установите её с PyPI через pip (pip install yfinance). Полная документация находится на отдельном сайте ranaroussi.github.io/yfinance.
Нужно ли что-то ещё, кроме установленного Python?Отдельные сервисы не нужны — pip подтянет всё сам. По умолчанию в установку входит curlcffi (используется как запасной вариант для запросов); в документации в разделе Advanced ▸ Installation описано, как установить без него.
Это официальный продукт Yahoo?Нет — yfinance не связан с Yahoo, не одобрен ею и не проверялся ею. Это независимый open-source инструмент, который использует публично доступные API Yahoo, поэтому Yahoo ничего не гарантирует.
Что разрешает лицензия — для кода и для данных?Код распространяется под Apache Software License (Apache-2.0). Но API Yahoo! Finance предназначен только для личного использования, и права на скачанные данные определяются условиями использования Yahoo.
Можно ли получить данные сразу по нескольким акциям?Да. Объект Tickers работает сразу с несколькими тикерами, а функция download загружает рыночные данные по нескольким тикерам за один вызов; один Ticker покрывает один символ.
Там цены в реальном времени или только исторические данные?Реальное время тоже есть: в yfinance входят компоненты WebSocket и AsyncWebSocket для потоковых данных в реальном времени поверх обычных загрузок.
Можно ли искать котировки и новости или отбирать акции по критериям?Да — компонент Search возвращает котировки и новости из поиска, EquityQuery и Screener позволяют строить запросы для скрининга рынка, а компоненты Sector и Industry дают информацию по секторам и отраслям.
Это зрелый проект или поделка на выходные?Проект существует с мая 2017 года и собрал более 25 000 звёзд на GitHub. Поддерживается он силами сообщества: в README сказано, что yfinance полагается на сообщество в поиске багов и написании кода.
Creator
ranaroussi
Size
10.2 MB
Stars
25.6K
Age
9y
Commits · 90 Days