stock-nse-india
Version:
This package will help us to get equity/index details and historical data from National Stock Exchange of India.
32 lines • 1.98 kB
TypeScript
import { ChartingOHLCResponse, EquityDetails, EquityTradeInfo, IntradayData, PreOpenMarketData } from './interface';
type PreOpenRow = PreOpenMarketData['data'][number];
export declare function isEquityDetailsShape(raw: unknown): raw is EquityDetails;
/** Pass-through when NSE returns standard quote-equity JSON. */
export declare function mapQuoteEquityResponse(raw: unknown): EquityDetails;
/**
* Build EquityDetails from /api/market-data-pre-open row when quote-equity is blocked.
* Fields not present in pre-open are filled with safe defaults.
*/
export interface EquityDetailsEnrichment {
companyName?: string;
isin?: string;
industry?: string;
currentMarketType?: string;
}
export declare function applyEquityDetailsEnrichment(details: EquityDetails, enrichment: EquityDetailsEnrichment): EquityDetails;
export declare function mapPreOpenRowToEquityDetails(row: PreOpenRow, symbol: string, currentMarketType?: string): EquityDetails;
export declare function isEquityTradeInfoShape(raw: unknown): raw is EquityTradeInfo;
/** Pass-through when NSE returns standard quote-equity trade_info JSON. */
export declare function mapQuoteEquityTradeInfoResponse(raw: unknown): EquityTradeInfo;
/**
* Build EquityTradeInfo from pre-open row when quote-equity trade_info is blocked.
*/
export declare function mapPreOpenRowToEquityTradeInfo(row: PreOpenRow, symbol: string): EquityTradeInfo;
/** Map NSE API/charting symbol param to equity page symbol for Referer warm-up. */
export declare function equityRefererSymbol(apiSymbol: string): string;
export declare function isIntradayDataShape(raw: unknown): raw is IntradayData;
export declare function mapIntradayApiResponse(raw: unknown, symbol: string): IntradayData;
export declare function mapChartingToIntradayData(chart: ChartingOHLCResponse, symbol: string): IntradayData;
export declare function isRetryableEquityEndpointError(error: unknown): boolean;
export {};
//# sourceMappingURL=equity-mappers.d.ts.map