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:971

getAllStockSymbols

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

getCirculars

getCirculars(): Promise<CircularsData>
Get circulars

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

getClearingHolidays

getClearingHolidays(): Promise<HolidaysBySegment>
Get clearing holidays

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

getCommodityOptionChain

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

getData

getData(url, domain?): Promise<any>
Parameters
- url: string
  
  NSE API's URL or charting API URL
- domain: "nse" | "charting" = 'nse'
  
  Domain type: 'nse' for www.nseindia.com, 'charting' for charting.nseindia.com
Returns Promise<any>
JSON data from NSE India or charting service
- Defined in index.ts:273

getDataByEndpoint

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

getEquityChartHistoricalData

getEquityChartHistoricalData(symbol, range?, token?, symbolType?, chartType?, timeInterval?): Promise<ChartingOHLCResponse>
Get historical chart data from charting.nseindia.com
Parameters
- symbol: string
  
  Equity symbol with series (e.g., 'ONGC')
- Optional range: DateRange
  
  Optional date range for chart data query
- Optional token: string | number
  
  NSE script code (token) for the symbol. If not provided, it is automatically fetched via getEquitySymbolInfo.
- symbolType: string = 'Equity'
  
  Type of symbol (e.g., 'Equity', 'Index')
- chartType: string = 'I'
  
  Chart type (e.g., 'I' for intraday, 'D' for daily)
- timeInterval: string | number = '5'
  
  Time interval in minutes (e.g., '5', '15', '60')
Returns Promise<ChartingOHLCResponse>
Chart data from charting service
- Defined in index.ts:376

getEquityCorporateInfo

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

getEquityDetails

getEquityDetails(symbol): Promise<EquityDetails>
Equity quote with fallback when /api/quote-equity is blocked (Akamai 403). Primary: quote-equity JSON; fallback: market-data-pre-open row for the symbol.
Parameters
- symbol: string
Returns Promise<EquityDetails>
- Defined in index.ts:541

getEquityHistoricalData

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

getEquityIntradayData

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

getEquityMaster

getEquityMaster(): Promise<EquityMaster>
Get equity master

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

getEquityOptionChain

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

getEquitySeries

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

getEquityStockIndices

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

getEquitySymbolInfo

getEquitySymbolInfo(symbol, segment?): Promise<ChartingSymbolInfo>
Look up the NSE script code (token) for an equity symbol using the charting domain. The scripCode in the returned object is the value that must be passed as token to getEquityChartHistoricalData.
Parameters
- symbol: string
  
  Equity symbol with series code (e.g., 'ONGC') OR plain symbol (e.g., 'ONGC')
- segment: string = ''
  
  Optional market segment filter (default: empty string, returns all segments)
Returns Promise<ChartingSymbolInfo>
Symbol information including scripCode / token
- Defined in index.ts:416

getEquityTradeInfo

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

getGlossary

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

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

getIndexIntradayData

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

getIndexNames

getIndexNames(): Promise<IndexNamesData>
Get index names

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

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:807

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:794

getLatestCirculars

getLatestCirculars(): Promise<LatestCircularData>
Get latest circulars

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

getMarketStatus

getMarketStatus(): Promise<MarketStatus>
Get market status

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

getMarketTurnover

getMarketTurnover(): Promise<MarketTurnover>
Get market turnover

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

getMergedDailyReportsCapital

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

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

getMergedDailyReportsDebt

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

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

getMergedDailyReportsDerivatives

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

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

getPreOpenMarketData

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

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

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:1046

getTradingHolidays

getTradingHolidays(): Promise<HolidaysBySegment>
Get trading holidays

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

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

domain: "nse" | "charting" = 'nse'

Returns Promise<any>

getDataByEndpoint

Parameters

apiEndpoint: string

Returns Promise<any>

getEquityChartHistoricalData

Parameters

symbol: string

Optional range: DateRange

Optional token: string | number

symbolType: string = 'Equity'

chartType: string = 'I'

timeInterval: string | number = '5'

Returns Promise<ChartingOHLCResponse>

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>

getEquitySymbolInfo

Parameters

symbol: string

segment: string = ''

Returns Promise<ChartingSymbolInfo>

getEquityTradeInfo

Parameters

symbol: string

Returns Promise<EquityTradeInfo>

getGlossary

`Optional` range: DateRange

`Optional` token: string | number

`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