Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 4.2 KB

README.md

File metadata and controls

117 lines (89 loc) · 4.2 KB
Raw

yahoofinancer

CRAN status R-CMD-check Codecov test coverage

Obtain historical and near real time data related to stocks, index and currencies from the Yahoo Finance API.

Installation

# Install rfm from CRAN
install.packages("yahoofinancer")

# Or the development version from GitHub
# install.packages("pak")
pak::pak("rsquaredacademy/yahoofinancer")

Quick Start

Ticker

To retrieve data from Yahoo Finance for a single stock, create an instance of the Ticker class by passing the company’s ticker symbol as an argument:

aapl <- Ticker$new('aapl')

# get historical market data
head(aapl$get_history(start = '2024-10-20', interval = '1d'))
#>                  date   volume   high    low   open  close adj_close
#> 1 2024-10-21 13:30:00 36254500 236.85 234.45 234.45 236.48  236.2201
#> 2 2024-10-22 13:30:00 38846600 236.22 232.60 233.89 235.86  235.6008
#> 3 2024-10-23 13:30:00 52287000 235.14 227.76 234.08 230.76  230.5064
#> 4 2024-10-24 13:30:00 31109500 230.82 228.41 229.98 230.57  230.3166
#> 5 2024-10-25 13:30:00 38802300 233.22 229.57 229.74 231.41  231.1557
#> 6 2024-10-28 13:30:00 36087100 234.73 232.55 233.32 233.40  233.1435

# meta info
# regular market price
aapl$regular_market_price
#> [1] 226.425

# 52 week high
aapl$fifty_two_week_high
#> [1] 237.49

# previous close
aapl$previous_close
#> [1] 225.12

Index

To retrieve data from Yahoo Finance for an index, create an instance of the Index class by passing the index symbol as an argument:

nifty_50 <- Index$new('^NSEI')

# get historical data
head(nifty_50$get_history(start = '2024-01-20', interval = '1d'))
#>                  date volume     high      low     open    close adj_close
#> 1 2024-01-23 03:45:00 449700 21750.25 21192.60 21716.70 21238.80   21238.8
#> 2 2024-01-24 03:45:00 407500 21482.35 21137.20 21185.25 21453.95  21453.95
#> 3 2024-01-25 03:45:00 418100 21459.00 21247.05 21454.60 21352.60   21352.6
#> 4 2024-01-29 03:45:00 376700 21763.25 21429.60 21433.10 21737.60   21737.6
#> 5 2024-01-30 03:45:00 375100 21813.05 21501.80 21775.75 21522.10   21522.1
#> 6 2024-01-31 03:45:00 410600 21741.35 21448.85 21487.25 21725.70   21725.7

Currency

head(currency_converter('GBP', 'USD', '2024-01-20', '2024-01-30'))
#>         date     high      low     open    close volume adj_close
#> 1 2024-01-22 1.273075 1.268826 1.270083 1.269986      0  1.269986
#> 2 2024-01-23 1.274714 1.265534 1.270826 1.270696      0  1.270696
#> 3 2024-01-24 1.277368 1.268681 1.269422 1.269197      0  1.269197
#> 4 2024-01-25 1.274226 1.269293 1.271844 1.271876      0  1.271876
#> 5 2024-01-26 1.275754 1.267732 1.270696 1.270826      0  1.270826
#> 6 2024-01-29 1.271941 1.266320 1.269712 1.269761      0  1.269761

IMPORTANT LEGAL DISCLAIMER

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

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

Code of Conduct

Please note that the yahoofinancer project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.