Community API for Yahoo-Finance.
Copyright (c) 2021 by Gadi Cohen and Pilwon Huh. MIT licensed.
You are reading the latest Development docs. For the v2 docs, click here. The dev docs are in the process of being updated for the upcoming v3 - for more info see UPGRADING.
Live Demo on CodeSandbox (Updated 2024-06-17; NextJS with both RSC and Hook-Relay examples)
NB: Recently the repo was renamed from node-yahoo-finance2 to
yahoo-finance2, and the following branches were named, master to main,
and devel to dev. See UPGRADING.md#dev for the
git commands to update your local installation.
- Bun: v1+.
- Cloudflare: Modern releases (we support but don't test for this, please report issues).
- Deno: v2+.
- Node: Current and Active LTS only; v20 until 2026-04-30, v22 until 2027-04-30, v24 until 2028-04-30.
This project is neither created nor endorsed by Yahoo Inc. Yahoo does not provide any official API to developers, nor makes any guarantees regarding service availability or API consistency. In practice however, the open source community has kept this project (and it's predecessor) working well since 2013.
Nevertheless, we make no guarantees and you use this package at your own risk. The developers (and obviously Yahoo) cannot be held responsible for any losses you may incur as a result of using this service. Use of this package is considered acknowledgement and acceptance of these terms and of its license.
CLI (Command line interface)
$ npx yahoo-finance2 --help
$ npx yahoo-finance2 search AMZN
$ npx yahoo-finance2 quoteSummary GOOGL
$ npx yahoo-finance2 quoteSummary NVDA '{"modules":["assetProfile", "secFilings"]}'
# or install it
$ npm install -g yahoo-finance2
$ yahoo-finance search MSFT '{ "someOption": true }'Importing
// or: const YahooFinance = require("yahoo-finance2").default;
import YahooFinance from "yahoo-finance2";
const yahooFinance = new YahooFinance();
const results = await yahooFinance.search("Apple");
const quote = await yahooFinance.quote('AAPL');
const { regularMarketPrice as price, currency } = quote;Available modules:
chart,
fundamentalsTimeSeries,
historical,
insights,
options,
quote,
quoteSummary
(submodules: assetProfile, balanceSheetHistory, balanceSheetHistoryQuarterly,
calendarEvents, cashflowStatementHistory, cashflowStatementHistoryQuarterly,
defaultKeyStatistics, earnings, earningsHistory, earningsTrend, financialData,
fundOwnership, fundPerformance, fundProfile, incomeStatementHistory,
incomeStatementHistoryQuarterly, indexTrend, industryTrend, insiderHolders,
insiderTransactions, institutionOwnership, majorDirectHolders,
majorHoldersBreakdown, netSharePurchaseActivity, price, quoteType,
recommendationTrend, secFilings, sectorTrend, summaryDetail, summaryProfile,
symbol, topHoldings, upgradeDowngradeHistory),
recommendationsBySymbol,
screener,
search,
trendingSymbols.
Extras:
quoteCombine.
See the Explanatatory Documentation and Full API Documentation.
Particularly, make sure to read the notes there on ERROR HANDLING. Be aware that if a stock gets delisted, Yahoo removes all related data, including historical (and chart) data from periods before the delisting occurred (i.e. queries that worked before will start failing, and there is no way to retrieve this data again).
Working with yahoo-finance2 is a joy if you're using TypeScript (but you don't
have to), with type checking and auto completion:
Try it yourself on our Live CodeSandbox.
It's not possible to run this in the browser, due to CORS and cookie issues. You should execute calls on a server or in a serverless or edge function, and pass this data to the browser as required. See the CodeSandbox above for examples. Use React Server Components, trpc, or other strategies to maintain types.
Pull Requests welcome! Read CONTRIBUTING.md and join our list of heroes:
-
Massive thanks to @pilwon for the original node-yahoo-finance and for all our prior collaborations on this and other projects 🙏
-
Special mention goes out to pudgereyem and PythonCreator27 who made significant contributions in the very early days of this project.