Wondering what’s next for npm?Check out our public roadmap! »

    yahoo-finance2
    TypeScript icon, indicating that this package has built-in type declarations

    1.10.4 • Public • Published

    node-yahoo-finance2

    Community API for Yahoo-Finance.

    Copyright (c) 2021 by Gadi Cohen <dragon@wastelands.net>. MIT licensed.

    npm CircleCI coverage semantic-release TypeScript MIT License

    Supports Node 12.0.0 and up (tests are run against 12.0.0).

    Beta release. Please let us know of any issues or edge cases. If you're looking for something stable and battle-tested, use the current node-yahoo-finance.

    Live Demo on CodeSandbox

    Unofficial API

    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 it's license.

    Quickstart

    CLI (Command line interface)

    $ npx yahoo-finance2 search AAPL
    
    # or install it
    $ npm install -g yahoo-finance2
    $ yahoo-finance search AAPL '{ "someOption": true }'

    Importing

    import yahooFinance from 'yahoo-finance2';
    
    const results = await yahooFinance.search('AAPL');
    const results = await yahooFInance.search('AAPL', { someOption: true, etc });

    Available modules: autoc, historical, 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), search, recommendationsBySymbol, trendingSymbols, options, with more coming soon.

    Extras: quoteCombine.

    See the Full Documentation.

    Even Quicker Start - Stock Price

    const quote = await yahooFinance.quote('AAPL');
    const { regularMarketPrice as price, currency } = quote;

    (Optional) TypeScript Love

    Working with yahoo-finance2 is a joy if you're using TypeScript (but you don't have to), with type checking and auto completion:

    Types Animation

    Try it yourself on our Live CodeSandbox.

    Using in the Browser (TL;DR; possible but unsupported)

    This project is primarily developed to be used server-side in node. Nevertheless, due to the large number on requests on this issue, we have taken care to ensure the package can be imported in the browser too.

    HOWEVER: you'll run into other challenges there that we can't help you with, particularly CORS issues when trying to query Yahoo's servers in the browser from non-Yahoo origins. Since Yahoo is specifically blocking such requests, we will not help you bypass them. (One way around this is to run your own server to proxy your requests, but we won't help you with this).

    Contributing

    Pull Requests welcome! Read CONTRIBUTING.md and join our list of heroes:

    contributor-faces

    Special mention goes out to pudgereyem and PythonCreator27 who made significant contributions in the very early days of this project.

    Credits

    • Massive thanks to @pilwon for the original node-yahoo-finance and for all our prior collaborations on this and other projects 🙏

    Install

    npm i yahoo-finance2

    DownloadsWeekly Downloads

    237

    Version

    1.10.4

    License

    MIT

    Unpacked Size

    255 kB

    Total Files

    56

    Last publish

    Collaborators

    • avatar
    • avatar