Class NseIndia

Hierarchy

NseIndia

Constructors

constructor

new NseIndia(): NseIndia
Returns NseIndia

Methods

getAllIndices

getAllIndices(): Promise<AllIndicesData>
Get all indices

Returns Promise<AllIndicesData>
List of all indices
- Defined in index.ts:452

getAllStockSymbols

getAllStockSymbols(): Promise<string[]>
Returns Promise<string[]>
List of NSE equity symbols
- Defined in index.ts:155

getCirculars

getCirculars(): Promise<CircularsData>
Get circulars

Returns Promise<CircularsData>
List of circulars
- Defined in index.ts:468

getClearingHolidays

getClearingHolidays(): Promise<HolidaysBySegment>
Get clearing holidays

Returns Promise<HolidaysBySegment>
List of clearing holidays
- Defined in index.ts:428

getCommodityOptionChain

getCommodityOptionChain(symbol): Promise<CommodityOptionChainData>
Parameters
- symbol: string
Returns Promise<CommodityOptionChainData>
- Defined in index.ts:403

getData

getData(url): Promise<any>
Parameters
- url: string
  
  NSE API's URL
Returns Promise<any>
JSON data from NSE India
- Defined in index.ts:116

getDataByEndpoint

getDataByEndpoint(apiEndpoint): Promise<any>
Parameters
- apiEndpoint: string
Returns Promise<any>
- Defined in index.ts:148

getEquityCorporateInfo

getEquityCorporateInfo(symbol): Promise<EquityCorporateInfo>
Parameters
- symbol: string
Returns Promise<EquityCorporateInfo>
- Defined in index.ts:182

getEquityDetails

getEquityDetails(symbol): Promise<EquityDetails>
Parameters
- symbol: string
Returns Promise<EquityDetails>
- Defined in index.ts:164

getEquityHistoricalData

getEquityHistoricalData(symbol, range?): Promise<EquityHistoricalData[]>
Parameters
- symbol: string
- Optional range: DateRange
Returns Promise<EquityHistoricalData[]>
- Defined in index.ts:204

getEquityIntradayData

getEquityIntradayData(symbol): Promise<IntradayData>
Parameters
- symbol: string
Returns Promise<IntradayData>
- Defined in index.ts:191

getEquityMaster

getEquityMaster(): Promise<EquityMaster>
Get equity master

Returns Promise<EquityMaster>
Equity master data with categorized indices
- Defined in index.ts:484

getEquityOptionChain

getEquityOptionChain(symbol): Promise<EquityOptionChainData>
Parameters
- symbol: string
Returns Promise<EquityOptionChainData>
- Defined in index.ts:391

getEquitySeries

getEquitySeries(symbol): Promise<SeriesData>
Parameters
- symbol: string
Returns Promise<SeriesData>
- Defined in index.ts:236

getEquityStockIndices

getEquityStockIndices(index): Promise<IndexDetails>
Parameters
- index: string
Returns Promise<IndexDetails>
- Defined in index.ts:252

getEquityTradeInfo

getEquityTradeInfo(symbol): Promise<EquityTradeInfo>
Parameters
- symbol: string
Returns Promise<EquityTradeInfo>
- Defined in index.ts:172

getGlossary

getGlossary(): Promise<Glossary>
Get NSE glossary content

Returns Promise<Glossary>
Glossary content
- Defined in index.ts:412

getIndexIntradayData

getIndexIntradayData(index): Promise<IntradayData>
Parameters
- index: string
Returns Promise<IntradayData>
- Defined in index.ts:260

getIndexNames

getIndexNames(): Promise<IndexNamesData>
Get index names

Returns Promise<IndexNamesData>
List of index names
- Defined in index.ts:460

getIndexOptionChain

getIndexOptionChain(indexSymbol, expiry?): Promise<IndexOptionChainData>
Parameters
- indexSymbol: string
- Optional expiry: string
  
  Optional expiry date in DD-MMM-YYYY format (e.g., "23-Dec-2025"). If not provided, will fetch nearest upcoming expiry
Returns Promise<IndexOptionChainData>
- Defined in index.ts:288

getIndexOptionChainContractInfo

getIndexOptionChainContractInfo(indexSymbol): Promise<OptionChainContractInfo>
Get option chain contract information (expiry dates and strike prices) for an index
Parameters
- indexSymbol: string
Returns Promise<OptionChainContractInfo>
- Defined in index.ts:275

getLatestCirculars

getLatestCirculars(): Promise<LatestCircularData>
Get latest circulars

Returns Promise<LatestCircularData>
List of latest circulars
- Defined in index.ts:476

getMarketStatus

getMarketStatus(): Promise<MarketStatus>
Get market status

Returns Promise<MarketStatus>
Current market status
- Defined in index.ts:436

getMarketTurnover

getMarketTurnover(): Promise<MarketTurnover>
Get market turnover

Returns Promise<MarketTurnover>
Market turnover data
- Defined in index.ts:444

getMergedDailyReportsCapital

getMergedDailyReportsCapital(): Promise<MergedDailyReportsData[]>
Get merged daily reports for capital market

Returns Promise<MergedDailyReportsData[]>
Daily reports for capital market
- Defined in index.ts:500

getMergedDailyReportsDebt

getMergedDailyReportsDebt(): Promise<MergedDailyReportsData[]>
Get merged daily reports for debt market

Returns Promise<MergedDailyReportsData[]>
Daily reports for debt market
- Defined in index.ts:516

getMergedDailyReportsDerivatives

getMergedDailyReportsDerivatives(): Promise<MergedDailyReportsData[]>
Get merged daily reports for derivatives

Returns Promise<MergedDailyReportsData[]>
Daily reports for derivatives
- Defined in index.ts:508

getPreOpenMarketData

getPreOpenMarketData(): Promise<PreOpenMarketData>
Get pre-open market data

Returns Promise<PreOpenMarketData>
Pre-open market data
- Defined in index.ts:492

getTechnicalIndicators

getTechnicalIndicators(symbol, period?, options?): Promise<TechnicalIndicators>
Get technical indicators for a specific equity symbol
Parameters
- symbol: string
  
  The equity symbol (e.g., 'RELIANCE', 'TCS')
- period: number = 200
  
  Number of days for historical data (default: 200)
- options: {
      adxPeriod?: number;
      atrPeriod?: number;
      bbPeriod?: number;
      bbStdDev?: number;
      cciPeriod?: number;
      emaPeriods?: number[];
      macdFast?: number;
      macdSignal?: number;
      macdSlow?: number;
      mfiPeriod?: number;
      momentumPeriod?: number;
      rocPeriod?: number;
      rsiPeriod?: number;
      smaPeriods?: number[];
      stochD?: number;
      stochK?: number;
      williamsRPeriod?: number;
  } = {}
  
  Optional configuration for indicators
  - Optional adxPeriod?: number
  - Optional atrPeriod?: number
  - Optional bbPeriod?: number
  - Optional bbStdDev?: number
  - Optional cciPeriod?: number
  - Optional emaPeriods?: number[]
  - Optional macdFast?: number
  - Optional macdSignal?: number
  - Optional macdSlow?: number
  - Optional mfiPeriod?: number
  - Optional momentumPeriod?: number
  - Optional rocPeriod?: number
  - Optional rsiPeriod?: number
  - Optional smaPeriods?: number[]
  - Optional stochD?: number
  - Optional stochK?: number
  - Optional williamsRPeriod?: number
Returns Promise<TechnicalIndicators>
Promise
- Defined in index.ts:527

getTradingHolidays

getTradingHolidays(): Promise<HolidaysBySegment>
Get trading holidays

Returns Promise<HolidaysBySegment>
List of trading holidays
- Defined in index.ts:420

Class NseIndia

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns NseIndia

Methods

getAllIndices

Returns Promise<AllIndicesData>

getAllStockSymbols

Returns Promise<string[]>

getCirculars

Returns Promise<CircularsData>

getClearingHolidays

Returns Promise<HolidaysBySegment>

getCommodityOptionChain

Parameters

symbol: string

Returns Promise<CommodityOptionChainData>

getData

Parameters

url: string

Returns Promise<any>

getDataByEndpoint

Parameters

apiEndpoint: string

Returns Promise<any>

getEquityCorporateInfo

Parameters

symbol: string

Returns Promise<EquityCorporateInfo>

getEquityDetails

Parameters

symbol: string

Returns Promise<EquityDetails>

getEquityHistoricalData

Parameters

symbol: string

Optional range: DateRange

Returns Promise<EquityHistoricalData[]>

getEquityIntradayData

Parameters

symbol: string

Returns Promise<IntradayData>

getEquityMaster

Returns Promise<EquityMaster>

getEquityOptionChain

Parameters

symbol: string

Returns Promise<EquityOptionChainData>

getEquitySeries

Parameters

symbol: string

Returns Promise<SeriesData>

getEquityStockIndices

Parameters

index: string

Returns Promise<IndexDetails>

getEquityTradeInfo

Parameters

symbol: string

Returns Promise<EquityTradeInfo>

getGlossary

Returns Promise<Glossary>

getIndexIntradayData

Parameters

index: string

Returns Promise<IntradayData>

getIndexNames

Returns Promise<IndexNamesData>

getIndexOptionChain

Parameters

indexSymbol: string

Optional expiry: string

Returns Promise<IndexOptionChainData>

getIndexOptionChainContractInfo

Parameters

indexSymbol: string

`Optional` range: DateRange

`Optional` expiry: string

`Optional` adxPeriod?: number

`Optional` atrPeriod?: number

`Optional` bbPeriod?: number

`Optional` bbStdDev?: number

`Optional` cciPeriod?: number

`Optional` emaPeriods?: number[]

`Optional` macdFast?: number

`Optional` macdSignal?: number

`Optional` macdSlow?: number

`Optional` mfiPeriod?: number

`Optional` momentumPeriod?: number

`Optional` rocPeriod?: number

`Optional` rsiPeriod?: number

`Optional` smaPeriods?: number[]

`Optional` stochD?: number

`Optional` stochK?: number

`Optional` williamsRPeriod?: number