{"id":22322903,"url":"https://github.com/finnhub-stock-api/finnhub-js","last_synced_at":"2025-07-29T15:31:31.173Z","repository":{"id":42811576,"uuid":"268677792","full_name":"Finnhub-Stock-API/finnhub-js","owner":"Finnhub-Stock-API","description":"Finnhub Javascript API Client. Finnhub API provides institutional-grade financial data to investors, fintech startups and investment firms. We support real-time stock price, global fundamentals and alternative data. https://finnhub.io/docs/api","archived":false,"fork":false,"pushed_at":"2023-10-17T08:37:00.000Z","size":1773,"stargazers_count":38,"open_issues_count":16,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-10-17T13:06:47.474Z","etag":null,"topics":["api","finnhub","stock"],"latest_commit_sha":null,"homepage":"https://finnhub.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Finnhub-Stock-API.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-02T02:02:51.000Z","updated_at":"2023-09-17T15:39:13.000Z","dependencies_parsed_at":"2023-02-13T13:16:07.150Z","dependency_job_id":null,"html_url":"https://github.com/Finnhub-Stock-API/finnhub-js","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finnhub-Stock-API%2Ffinnhub-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finnhub-Stock-API%2Ffinnhub-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finnhub-Stock-API%2Ffinnhub-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Finnhub-Stock-API%2Ffinnhub-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Finnhub-Stock-API","download_url":"https://codeload.github.com/Finnhub-Stock-API/finnhub-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228024102,"owners_count":17857628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","finnhub","stock"],"created_at":"2024-12-04T01:08:46.390Z","updated_at":"2025-07-29T15:31:31.144Z","avatar_url":"https://github.com/Finnhub-Stock-API.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# finnhub-js\n\nOfficial JavaScript client for Finnhub https://finnhub.io/\n\n- API version: 1.0.0\n- Package version: 2.2.0\n\n## Installation\n\n```shell\nnpm install finnhub --save\n```\n\n## Getting Started\n\n```javascript\nconst finnhub = require('finnhub');\n\nconst finnhubClient = new finnhub.DefaultApi(\"\u003cAPI_key\u003e\") // Replace this\n\n// Stock candles\nfinnhubClient.stockCandles(\"AAPL\", \"D\", 1590988249, 1591852249, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Company News\nfinnhubClient.companyNews(\"AAPL\", \"2020-01-01\", \"2020-05-01\", (error, data, response) =\u003e {\n    if (error) {\n        console.error(error);\n    } else {\n        console.log(data)\n    }\n});\n\n// Investor Ownership\nlet optsLimit = {'limit': 10};\nfinnhubClient.ownership(\"AAPL\", optsLimit, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Aggregate Indicator\nfinnhubClient.aggregateIndicator(\"AAPL\", \"D\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Basic financials\nfinnhubClient.companyBasicFinancials(\"AAPL\", \"margin\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Company earnings\nfinnhubClient.companyEarnings(\"AAPL\", {'limit': 10}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Company EPS estimates\nfinnhubClient.companyEpsEstimates(\"AAPL\", {}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Ebitda Estimates\nfinnhubClient.companyEbitdaEstimates(\"AAPL\", {\"freq\": \"annual\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Ebit Estimates\nfinnhubClient.companyEbitEstimates(\"AAPL\", {\"freq\": \"annual\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Company executive\nfinnhubClient.companyExecutive(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Company peers\nfinnhubClient.companyPeers(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Company profile\nfinnhubClient.companyProfile({'symbol': 'AAPL'}, (error, data, response) =\u003e {\n    console.log(data)\n});\nfinnhubClient.companyProfile({'isin': 'US0378331005'}, (error, data, response) =\u003e {\n    console.log(data)\n});\nfinnhubClient.companyProfile({'cusip': '037833100'}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Company profile2\nfinnhubClient.companyProfile2({'symbol': 'AAPL'}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Revenue Estimates\nfinnhubClient.companyRevenueEstimates(\"AAPL\", {}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// List country\nfinnhubClient.country((error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Covid-19\nfinnhubClient.covid19((error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Crypto candles\nfinnhubClient.cryptoCandles(\"BINANCE:BTCUSDT\", \"D\", 1590988249, 1591852249, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Crypto exchanges\nfinnhubClient.cryptoExchanges((error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Crypto symbols\nfinnhubClient.cryptoSymbols(\"BINANCE\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Earnings calendar\nfinnhubClient.earningsCalendar({\"from\": \"2020-06-01\", \"to\": \"2020-06-30\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Economic code\nfinnhubClient.economicCode((error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Economic data\nfinnhubClient.economicData(\"MA-USA-656880\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Filings\nfinnhubClient.filings({\"symbol\": \"AAPL\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Financials\nfinnhubClient.financials(\"AAPL\", \"ic\", \"annual\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Financials Reported\nfinnhubClient.financialsReported({\"symbol\": \"AAPL\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Forex candles\nfinnhubClient.forexCandles(\"OANDA:EUR_USD\", \"D\", 1590988249, 1591852249, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Forex exchanges\nfinnhubClient.forexExchanges((error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Forex rates\nfinnhubClient.forexRates({\"base\": \"USD\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Forex symbols\nfinnhubClient.forexSymbols(\"OANDA\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Fund ownership\nfinnhubClient.fundOwnership(\"AAPL\", {'limit': 10}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// General news\nfinnhubClient.marketNews(\"general\", {}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Ipo calendar\nfinnhubClient.ipoCalendar(\"2020-01-01\", \"2020-06-15\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Major development\nfinnhubClient.pressReleases(\"AAPL\", {}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// News sentiment\nfinnhubClient.newsSentiment(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Pattern recognition\nfinnhubClient.patternRecognition(\"AAPL\", \"D\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Price target\nfinnhubClient.priceTarget(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n//Quote\nfinnhubClient.quote(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Recommendation trends\nfinnhubClient.recommendationTrends(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Stock dividends\nfinnhubClient.stockDividends(\"KO\", \"2019-01-01\", \"2020-06-30\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Splits\nfinnhubClient.stockSplits(\"AAPL\", \"2000-01-01\", \"2020-06-15\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Stock symbols\nfinnhubClient.stockSymbols(\"US\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Support resistance\nfinnhubClient.supportResistance(\"AAPL\", \"D\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Technical indicator\nfinnhubClient.technicalIndicator(\"AAPL\", \"D\", 1580988249, 1591852249, \"macd\", {}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Transcripts\nfinnhubClient.transcripts(\"AAPL_162777\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Transcripts list\nfinnhubClient.transcriptsList(\"AAPL\", (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Upgrade/downgrade\nfinnhubClient.upgradeDowngrade({\"symbol\": \"AAPL\"}, (error, data, response) =\u003e {\n    console.log(data)\n});\n\n// Tick Data\nfinnhubClient.stockTick(\"AAPL\", \"2020-03-25\", 500, 0, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Indices Constituents\nfinnhubClient.indicesConstituents(\"^GSPC\", (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Indices Historical Constituents\nfinnhubClient.indicesHistoricalConstituents(\"^GSPC\", (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// ETFs Profile\nfinnhubClient.etfsProfile({'symbol': 'SPY'}, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// ETFs Holdings\nfinnhubClient.etfsHoldings({'symbol': 'ARKK'}, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// ETFs Industry Exposure\nfinnhubClient.etfsSectorExposure('SPY', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// ETFs Country Exposure\nfinnhubClient.etfsCountryExposure('SPY', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Mutual Funds Profile\nfinnhubClient.mutualFundProfile({'symbol': 'VTSAX'}, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Mutual Funds Holdings\nfinnhubClient.mutualFundHoldings({'symbol': 'VTSAX'}, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Mutual Funds Industry Exposure\nfinnhubClient.mutualFundSectorExposure('VTSAX', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Mutual Funds Country Exposure\nfinnhubClient.mutualFundCountryExposure('VTSAX', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Insider Transactions\nfinnhubClient.insiderTransactions('AAPL', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Revenue Breakdown\nfinnhubClient.revenueBreakdown({'symbol': 'AAPL'}, (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Social Sentiment\nfinnhubClient.socialSentiment('GME', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Investment Theme\nfinnhubClient.investmentThemes('financialExchangesData', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Supply Chain\nfinnhubClient.supplyChainRelationships('AAPL', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Company ESG\nfinnhubClient.companyEsgScore('AAPL', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Company Earnings Quality Score\nfinnhubClient.companyEarningsQualityScore('AAPL', 'quarterly', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Crypto Profile\nfinnhubClient.cryptoProfile('BTC', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// USPO Patent\nfinnhubClient.stockUsptoPatent('NVDA', '2021-01-01', '2021-12-31', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n// Visa Application\nfinnhubClient.stockVisaApplication('AAPL', '2021-01-01', '2021-12-31', (error, data, response) =\u003e {\n    console.log(data);\n});\n\n```\n\n## License\n\nApache License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinnhub-stock-api%2Ffinnhub-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinnhub-stock-api%2Ffinnhub-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinnhub-stock-api%2Ffinnhub-js/lists"}