Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Yahoo Finance v7 API (since 2017-05-16) - final work (3/3) #42

Merged
merged 2 commits into from
Feb 18, 2021
Merged

[WIP] Yahoo Finance v7 API (since 2017-05-16) - final work (3/3) #42

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e936e6
readme: cleanup "new" API clarification, remove top notice about it
gadicc Nov 25, 2020
97501dc
readme: add note about first request taking longer and why (#42)
gadicc Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
## PLEASE READ: This library is partially broken due to sudden API change by Yahoo Finance. The fantastic [@gadicc](https://github.com/gadicc) is currently working on a fix to support the new API. Please follow [PR #42](https://github.com/pilwon/node-yahoo-finance/pull/42) for the progress.

# yahoo-finance

`yahoo-finance` is [Yahoo Finance](http://finance.yahoo.com/) historical quotes and snapshot data downloader written in [Node.js](http://nodejs.org/).
Expand All @@ -11,14 +9,23 @@ Also check out [google-finance](https://github.com/pilwon/node-google-finance).

## Important: New Yahoo API

Yahoo completely replaced their API on 2017-05-16. This interim release is intended to get you up and running again quickly, but we're still working on it. Note also that Yahoo stopped supporting their API for developers some time ago, so no guarantees can be made about service availability, but probably this package will keep working thanks to the magic of open-source. Regarding the package API:
This project is compatible with Yahoo's "new" (and internal) API from
2017-05-16. Please be aware that Yahoo stopped supporting their API for
developers many years ago, so in theory this could stop working at any time
and without prior notice. In practice, however, the magic of open-source has
kept this project working reliably and continuously for years and years.

Regarding the package API:

* `historical()` - should work as expected - please check the output and report any inconsistencies.

* `snapshot()` - deprecated - returns the original format for SOME old options via a mapping layer. Since Yahoo's new API does not contain all the same data as the old version, 100% compatibility is impossible - but for the most common options, this should ease upgrade pains. When you can, transition to the new `quote()` API instead.

* `quote()` - NEW API more faithful to Yahoo's new API. See below. This replaces `snapshot()` and we suggest you use it instead.

* Note: your very first request will take a bit longer to return, as we need to
first send an additional request to Yahoo to get a "crumb" that is used for
all future quests.

## Installation

Expand Down