The Fincrux API TypeScript/JavaScript Client

The official TypeScript/JavaScript client for communicating with the Fincrux API.

Fincrux exposes REST APIs for company fundamentals, historical candles, corporate actions, peer competitors, and FII/DII market activity.

Licensed under the MIT License.

Documentation

• Fincrux HTTP API documentation

Requirements

• NodeJS v18.0.0+

Installation

Install via npm

npm install fincrux@latest

Or via yarn

yarn add fincrux

Getting started with API

import { Fincrux } from "fincrux";

const apiKey = "your_api_key";

const fc = new Fincrux({ api_key: apiKey });

async function init() {
  try {
    await search();
    await financials();
    await fii();
  } catch (err) {
    console.error(err);
  }
}

async function search() {
  try {
    const results = await fc.searchCompany("reliance");
    console.log("Search:", results);
  } catch (err) {
    console.error("Error searching:", err);
  }
}

async function financials() {
  try {
    const data = await fc.getCompanyFinancials("RELIANCE");
    console.log("Financials:", data.company, data.data?.top_ratios);
  } catch (err) {
    console.error("Error getting financials:", err);
  }
}

async function fii() {
  try {
    const activity = await fc.getFII(["cash", "index_futures"], {
      interval: "1D",
    });
    console.log("FII:", activity);

    const dii = await fc.getDII({ interval: "1D" });
    console.log("DII:", dii);
  } catch (err) {
    console.error("Error getting market activity:", err);
  }
}

init();

API methods

Method	Description
allCompanies()	List all companies
searchCompany(query)	Search companies by name
getCompanyFinancials(symbol)	Financial statements and ratios
getCompanyHistoricals(symbol, options?)	OHLC candles
getCorporateActions(symbol, options?)	Corporate actions
getCompetitors(symbol, options?)	Peer competitors
getFII(data_type, options?)	FII cash / F&O activity
getDII(options?)	DII cash activity

Historical intervals

1minute, 30minutes, day, week, month

FII / DII intervals

1D, 1M

FII data types

index_futures, stock_futures, index_options, stock_options, cash

Run unit tests

npm run test

Lint and format

npm run check
npm run format

Generate documentation

npm install typedoc --save-dev
npx typedoc --out ./docs

Changelog

Check CHANGELOG.md