Skip to content

Commit

Permalink
readme: cleanup "new" API clarification, remove top notice about it
Browse files Browse the repository at this point in the history
  • Loading branch information
gadicc committed Nov 25, 2020
1 parent 1f07e12 commit 4e936e6
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
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,7 +9,13 @@ 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.

Expand Down

0 comments on commit 4e936e6

Please sign in to comment.