📊 Finsight

A TypeScript/Node.js library to fetch comprehensive stock-related information such as financials, reports, shareholder patterns, credit ratings, sentiments, and more from multiple sources including Screener.in and Economic Times.

---

🚀 Installation

From local build (development)

npm install /path/to/this/screener-library/on-your-system

---

📦 Usage

JavaScript (CommonJS)

const ScreenerInformation = require("finsight").default;

const main = async () => {
  const ticker = "INFY";

  const screener = new ScreenerInformation(ticker);
  const shareholding = await screener.getShareholdingPattern();

  console.log("Shareholding Pattern:", shareholding);
};

main();

---

TypeScript (ESM)

import ScreenerInformation from "finsight";

async function main() {
  const ticker = "INFY";

  const screener = new ScreenerInformation(ticker);

  const quarterlyResults = await screener.getQuarterlyResults();
  console.log("Quarterly Results:", quarterlyResults);
}

main();

---

🧩 API Reference

For now all methods return a Promise<LooseObject>.

Constructor

new ScreenerInformation(ticker: string, source?: SourceType)

• ticker → Stock ticker (e.g., "INFY", "RELIANCE")

• source → Defaults to SourceType.SCREENER Options:

  • SourceType.SCREENER
  • SourceType.ECONOMIC_TIMES - Not Supported Yet

---

Methods

Method	Description
getShareholdingPattern()	Returns the shareholding pattern of the company.
getCreditRatings()	Fetches credit rating details.
getSentiments()	Provides sentiment analysis.
getQuarterlyResults()	Returns quarterly financial results.
getProfitAndLoss()	Returns profit & loss statement.
getAnnouncements()	Fetches company announcements.
getAnnualReport()	Returns annual reports.
getConcall()	Fetches concall transcripts.
getBalanceSheet()	Returns balance sheet data.
getCashflow()	Returns cashflow statement.
getRatio()	Returns financial ratios.

---

🛠 Development

Clone and build locally:

git clone https://github.com/Sparsh-Kumar/finsight.git
cd screener-information
npm install
npm run build

---

⚖️ License

MIT © 2025 Sparsh Kumar Built with ❤️ for developers and investors.