nse-bse-api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 NSE-BSE API
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,194 @@
+# NSE-BSE API
+
+A unified TypeScript API for both NSE (National Stock Exchange) and BSE (Bombay Stock Exchange) India. This package combines the functionality of both exchanges while keeping their APIs separate and isolated.
+
+## Features
+
+### NSE API Features
+- 📈 **Real-time Stock Quotes** - Get live stock prices and market data
+- 📊 **Historical Data** - Fetch historical stock prices and indices
+- 🔍 **Symbol Lookup** - Search for stocks and securities
+- 📋 **Option Chain Data** - Complete options data with Greeks
+- 🏢 **Corporate Actions** - Dividends, splits, bonuses, and more
+- 📰 **Corporate Announcements** - Latest company announcements
+- 💹 **Market Status** - Live market status and trading hours
+- 📁 **Data Downloads** - Bhavcopy and other reports
+- 🎯 **IPO Information** - Current, past, and upcoming IPOs
+
+### BSE API Features
+- 📈 **Stock Quotes** - Real-time BSE stock prices
+- 📊 **Historical Data** - Historical price data and indices
+- 🔍 **Symbol Search** - Find BSE listed companies
+- 🏆 **Gainers/Losers** - Top performing stocks
+- 📋 **Corporate Actions** - Dividend, bonus, rights issues
+- 📰 **Announcements** - Corporate announcements and news
+- 📁 **Reports** - Bhavcopy and delivery reports
+- 🎯 **Result Calendar** - Earnings announcement dates
+
+## Installation
+
+```bash
+npm install nse-bse-api
+```
+
+## Quick Start
+
+### Using Both APIs
+
+```typescript
+import { NSE, BSE } from 'nse-bse-api';
+
+// Initialize clients
+const nse = new NSE();
+const bse = new BSE();
+
+// Get NSE quote
+const nseQuote = await nse.equityQuote('RELIANCE');
+console.log('NSE RELIANCE:', nseQuote);
+
+// Get BSE quote  
+const bseQuote = await bse.quote('500325'); // RELIANCE BSE code
+console.log('BSE RELIANCE:', bseQuote);
+
+// Clean up
+await nse.exit();
+await bse.close();
+```
+
+### Using Individual APIs
+
+```typescript
+// Import only NSE
+import { NSE } from 'nse-bse-api/nse';
+
+const nse = new NSE();
+const quote = await nse.equityQuote('TCS');
+
+// Import only BSE
+import { BSE } from 'nse-bse-api/bse';
+
+const bse = new BSE();
+const quote = await bse.quote('532540'); // TCS BSE code
+```
+
+## API Documentation
+
+### NSE API
+
+#### Basic Usage
+
+```typescript
+import { NSE } from 'nse-bse-api';
+
+const nse = new NSE('./downloads');
+
+// Get stock quote
+const quote = await nse.equityQuote('RELIANCE');
+
+// Get historical data
+const historical = await nse.historical.fetchEquityHistoricalData({
+  symbol: 'RELIANCE',
+  from_date: new Date('2024-01-01'),
+  to_date: new Date('2024-01-31')
+});
+
+// Get option chain
+const optionChain = await nse.options.getOptionChain('NIFTY');
+
+// Search symbols
+const results = await nse.market.lookup('reliance');
+```
+
+#### Available Methods
+
+- `equityQuote(symbol)` - Get equity quote
+- `market.lookup(query)` - Search symbols
+- `market.getStatus()` - Market status
+- `historical.fetchEquityHistoricalData(params)` - Historical data
+- `options.getOptionChain(symbol)` - Option chain
+- `corporate.getActions(params)` - Corporate actions
+- `ipo.listCurrentIPO()` - Current IPOs
+
+### BSE API
+
+#### Basic Usage
+
+```typescript
+import { BSE } from 'nse-bse-api';
+
+const bse = new BSE();
+
+// Get stock quote
+const quote = await bse.quote('500325'); // RELIANCE
+
+// Get gainers
+const gainers = await bse.gainers();
+
+// Get corporate actions
+const actions = await bse.actions({
+  fromDate: new Date('2024-01-01'),
+  toDate: new Date('2024-01-31')
+});
+
+// Search symbol
+const results = await bse.lookupSymbol('reliance');
+```
+
+#### Available Methods
+
+- `quote(scripcode)` - Get stock quote
+- `gainers(options)` - Top gainers
+- `losers(options)` - Top losers
+- `actions(options)` - Corporate actions
+- `announcements(options)` - Corporate announcements
+- `lookupSymbol(text)` - Search symbols
+- `fetchHistoricalIndexData(options)` - Historical index data
+
+## Configuration
+
+### NSE Configuration
+
+```typescript
+const nse = new NSE('./downloads', {
+  server: false,    // Use server mode
+  timeout: 10000   // Request timeout in ms
+});
+```
+
+### BSE Configuration
+
+```typescript
+const bse = new BSE({
+  downloadFolder: './downloads',
+  timeout: 10000
+});
+```
+
+## Error Handling
+
+```typescript
+import { NSE, BSE } from 'nse-bse-api';
+
+try {
+  const nse = new NSE();
+  const quote = await nse.equityQuote('INVALID');
+} catch (error) {
+  console.error('NSE Error:', error.message);
+}
+
+try {
+  const bse = new BSE();
+  const quote = await bse.quote('INVALID');
+} catch (error) {
+  console.error('BSE Error:', error.message);
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

package/dist/bse/BSE.d.ts

@@ -0,0 +1,141 @@
+import { BSEConfig, QuoteData, ActionData, AnnouncementsResponse, ResultCalendarData, AdvanceDeclineData, GainerLoserData, Near52WeekData, WeeklyHighLowData, SecurityData, LookupResult, IndexData, Segment, ByDateType, ByType, PctChange, Period, Status } from './types/index.js';
+/**
+ * Unofficial TypeScript API for BSE India
+ */
+export declare class BSE {
+    static readonly version = "1.0.0";
+    static readonly baseUrl = "https://www.bseindia.com/";
+    static readonly apiUrl = "https://api.bseindia.com/BseIndiaAPI/api";
+    static readonly validGroups: string[];
+    private session;
+    private dir;
+    private symbolParser;
+    constructor(config?: BSEConfig);
+    /**
+     * Close the HTTP session
+     */
+    close(): void;
+    private download;
+    private request;
+    private lookup;
+    /**
+     * Download the daily bhavcopy report for specified date
+     */
+    bhavcopyReport(date: Date, folder?: string): Promise<string>;
+    /**
+     * Download the daily delivery report for specified date
+     */
+    deliveryReport(date: Date, folder?: string): Promise<string>;
+    /**
+     * All corporate announcements
+     */
+    announcements(options?: {
+        pageNo?: number;
+        fromDate?: Date;
+        toDate?: Date;
+        segment?: Segment;
+        scripcode?: string;
+        category?: string;
+        subcategory?: string;
+    }): Promise<AnnouncementsResponse>;
+    /**
+     * All forthcoming corporate actions
+     */
+    actions(options?: {
+        segment?: Segment;
+        fromDate?: Date;
+        toDate?: Date;
+        byDate?: ByDateType;
+        scripcode?: string;
+        sector?: string;
+        purposeCode?: string;
+    }): Promise<ActionData[]>;
+    /**
+     * Corporate result calendar
+     */
+    resultCalendar(options?: {
+        fromDate?: Date;
+        toDate?: Date;
+        scripcode?: string;
+    }): Promise<ResultCalendarData[]>;
+    /**
+     * Advance decline values for all BSE indices
+     */
+    advanceDecline(): Promise<AdvanceDeclineData[]>;
+    /**
+     * List of top gainers
+     */
+    gainers(options?: {
+        by?: ByType;
+        name?: string;
+        pctChange?: PctChange;
+    }): Promise<GainerLoserData[]>;
+    /**
+     * List of top losers
+     */
+    losers(options?: {
+        by?: ByType;
+        name?: string;
+        pctChange?: PctChange;
+    }): Promise<GainerLoserData[]>;
+    /**
+     * Get stocks near 52 week highs and lows
+     */
+    near52WeekHighLow(options?: {
+        by?: ByType;
+        name?: string;
+    }): Promise<Near52WeekData>;
+    /**
+     * Get OHLC quotes for given scripcode
+     */
+    quote(scripcode: string): Promise<QuoteData>;
+    /**
+     * Get 52 week and monthly high & low data for given stock
+     */
+    quoteWeeklyHL(scripcode: string): Promise<WeeklyHighLowData>;
+    /**
+     * List securities and their meta info
+     */
+    listSecurities(options?: {
+        industry?: string;
+        scripcode?: string;
+        group?: string;
+        segment?: string;
+        status?: Status;
+    }): Promise<SecurityData[]>;
+    /**
+     * Search by Company name, stock symbol, ISIN or BSE code
+     */
+    lookupSymbol(text: string): Promise<LookupResult | null>;
+    /**
+     * Get stock symbol name for BSE scrip code
+     */
+    getScripName(scripcode: string): Promise<string>;
+    /**
+     * Get BSE scrip code for stock symbol name
+     */
+    getScripCode(scripname: string): Promise<string>;
+    /**
+     * Fetch daily data for all indices for a given date
+     */
+    fetchAllIndicesDataByDate(date: Date): Promise<Record<string, IndexData[]>>;
+    /**
+     * Download historical data for the specified index for the given date range
+     */
+    fetchHistoricalIndexData(options: {
+        index: string;
+        fromDate: Date;
+        toDate: Date;
+        period?: Period;
+        folder?: string;
+    }): Promise<string | null>;
+    /**
+     * Fetch the list of Indices
+     */
+    fetchIndexNames(): Promise<Record<string, IndexData[]>>;
+    /**
+     * Returns metadata about AllIndices report
+     */
+    fetchIndexReportMetadata(): Promise<Record<string, IndexData[]>>;
+}
+//# sourceMappingURL=BSE.d.ts.map

package/dist/bse/BSE.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BSE.d.ts","sourceRoot":"","sources":["../../src/bse/BSE.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EACT,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,OAAO,EACP,UAAU,EACV,MAAM,EACN,SAAS,EACT,MAAM,EACN,MAAM,EAIP,MAAM,kBAAkB,CAAC;AAK1B;;GAEG;AACH,qBAAa,GAAG;IACd,MAAM,CAAC,QAAQ,CAAC,OAAO,WAAW;IAClC,MAAM,CAAC,QAAQ,CAAC,OAAO,+BAA+B;IACtD,MAAM,CAAC,QAAQ,CAAC,MAAM,8CAA8C;IAEpE,MAAM,CAAC,QAAQ,CAAC,WAAW,WAGzB;IAEF,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,YAAY,CAAe;gBAEvB,MAAM,GAAE,SAAc;IAmBlC;;OAEG;IACH,KAAK,IAAI,IAAI;YAIC,QAAQ;YAqCR,OAAO;YAwBP,MAAM;IAUpB;;OAEG;IACG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAclE;;OAEG;IACG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA+BlE;;OAEG;IACG,aAAa,CAAC,OAAO,GAAE;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,IAAI,CAAC;QAChB,MAAM,CAAC,EAAE,IAAI,CAAC;QACd,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAuCvC;;OAEG;IACG,OAAO,CAAC,OAAO,GAAE;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,IAAI,CAAC;QAChB,MAAM,CAAC,EAAE,IAAI,CAAC;QACd,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IA0C9B;;OAEG;IACG,cAAc,CAAC,OAAO,GAAE;QAC5B,QAAQ,CAAC,EAAE,IAAI,CAAC;QAChB,MAAM,CAAC,EAAE,IAAI,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAuBtC;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,kBAAkB,EAAE,CAAC;IASrD;;OAEG;IACG,OAAO,CAAC,OAAO,GAAE;QACrB,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,SAAS,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAwBnC;;OAEG;IACG,MAAM,CAAC,OAAO,GAAE;QACpB,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,SAAS,CAAC;KAClB,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAwBnC;;OAEG;IACG,iBAAiB,CAAC,OAAO,GAAE;QAC/B,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;KACV,GAAG,OAAO,CAAC,cAAc,CAAC;IAwChC;;OAEG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAsBlD;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAuBlE;;OAEG;IACG,cAAc,CAAC,OAAO,GAAE;QAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACZ,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IA6BhC;;OAEG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAS9D;;OAEG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IActD;;OAEG;IACG,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IActD;;OAEG;IACG,yBAAyB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAiBjF;;OAEG;IACG,wBAAwB,CAAC,OAAO,EAAE;QACtC,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,IAAI,CAAC;QACf,MAAM,EAAE,IAAI,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAgC1B;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAS7D;;OAEG;IACG,wBAAwB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;CAQvE"}