| Function | Description | Return Type |
|----------|-------------|-------------|
| getTopGainers() | Get top gaining stocks | Promise |
| getTopLoosers() | Get top losing stocks | Promise |
| getTopTenTradeScrips() | Get top traded by volume | Promise |
| getTopTenTransactions() | Get top by transaction count | Promise |
| getTopTenTurnover() | Get top by turnover | Promise |

$3

| Function | Description | Return Type |
|----------|-------------|-------------|
| getNepseIndex() | Get all NEPSE indices | Promise |
| getNepseIndexIntraday(index) | Get intraday data for an index | Promise |
| getIndexPriceVolumeHistory(index, size) | Get historical data for an index | Promise |

$3

| Function | Description | Return Type |
|----------|-------------|-------------|
| getSecurityList() | Get list of all securities | Promise |
| getCompaniesList() | Get list of all companies | Promise |
| get_security_detail(symbol) | Get detailed security info | Promise |

$3

| Function | Description | Return Type |
|----------|-------------|-------------|
| stockIntraday(symbol) | Get intraday chart data | Promise |
| getStockDailyPrice(symbol) | Get daily price data | Promise |
| getPriceVolumeHistory(symbol, size) | Get historical price/volume | Promise |
| getMarket_depth(symbol) | Get market depth | Promise |

$3

| Function | Description | Return Type |
|----------|-------------|-------------|
| disclosure() | Get recent company disclosures | Promise |

Worker Pool Configuration

The worker pool automatically manages workers with the following defaults:

| Option | Default | Description |
|--------|---------|-------------|
| minWorkers | 1 | Minimum number of workers to maintain |
| maxWorkers | 10 | Maximum number of workers |
| idleTimeout | 30,000ms | Time before idle workers are terminated |
| taskTimeout | 60,000ms | Timeout for individual tasks |
| maxRetries | 3 | Number of retries for failed tasks |
| scalingThreshold | 0.8 | Scale up when 80% of workers are busy |

For advanced configuration, you can create a custom worker pool:

`typescript
import { WorkerPool } from 'nepse-api-unofficial';

const pool = new WorkerPool({
minWorkers: 2,
maxWorkers: 20,
idleTimeout: 60_000,
taskTimeout: 30_000,
maxRetries: 5,
scalingThreshold: 0.6,
logger: {
log: (msg) => console.log(msg),
warn: (msg) => console.warn(msg),
error: (msg, err) => console.error(msg, err),
},
});
`

Examples

$3

`typescript
import {
get_market_status,
getSummary,
getTopGainers,
getTopLoosers,
getNepseIndex,
getWorkerPoolStats,
shutdownWorkerPool,
} from 'nepse-api-unofficial';

// Fire multiple requests concurrently
const [status, summary, gainers, losers, indices] = await Promise.all([
get_market_status(),
getSummary(),
getTopGainers(),
getTopLoosers(),
getNepseIndex(),
]);

console.log('Market:', status?.isOpen);
console.log('Summary:', summary);
console.log('Top Gainer:', gainers?.[0]);
console.log('Top Loser:', losers?.[0]);
console.log('NEPSE Index:', indices?.['NEPSE Index']);

// Check how the worker pool handled the load
console.log('Pool Stats:', getWorkerPoolStats());

// Always shutdown gracefully
await shutdownWorkerPool();
`

$3

`typescript
import { get_security_detail, getMarket_depth } from 'nepse-api-unofficial';

// Get detailed information about NABIL bank
const nabil = await get_security_detail('NABIL');
console.log({
symbol: nabil?.security.symbol,
name: nabil?.security.securityName,
ltp: nabil?.securityDailyTradeDto?.lastTradedPrice,
});

// Get market depth
const depth = await getMarket_depth('NABIL');
console.log('Buy orders:', depth?.totalBuyQty);
console.log('Sell orders:', depth?.totalSellQty);
`

TypeScript

This package is written in TypeScript and provides full type definitions:

`typescript
import type {
MarketStatus,
Summary,
SecurityDetailResponse,
TopGainerLoosers,
IndexKey,
WorkerPoolOptions,
// ... and many more
} from 'nepse-api-unofficial';
`

$3

The package exports Zod schemas for runtime validation:

`typescript
import {
StockDailyPriceSchema,
marketDepthResponse,
SupplyDemandSchema,
} from 'nepse-api-unofficial';

// Validate data at runtime
const validated = StockDailyPriceSchema.parse(data);
`

Error Handling

All methods return null on failure instead of throwing exceptions:

`typescript
const status = await get_market_status();
if (!status) {
console.log('Failed to fetch market status');
return;
}

// Safe to use status here
console.log('Market:', status.isOpen);
`

SSL/TLS Note

NEPSE's API server sometimes has SSL certificate issues. This library temporarily disables SSL verification for API calls. While this is necessary for the API to work, be aware of this security consideration.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Development

`bash


Install dependencies

License

MIT License - see the LICENSE file for details.

Author

Suraj Rimal - GitHub

Acknowledgments

- Nepal Stock Exchange for providing the data
- The open-source community for inspiration

---

⭐ Star this repo if you find it useful!