📈 Staxa Stock API Client

A simple and lightweight JavaScript/Node.js client to fetch live stock prices and mutual fund NAVs from the Staxa Stock API.

Built for easy integration into your apps, dashboards, or investment trackers.

🚀 Features

• Fetch individual stock prices (NSE)
• Fetch batch stock prices (multiple stocks in one call)
• Fetch mutual fund NAVs
• Built-in API Key authentication
• Lightweight & easy to use

📦 Installation

npm install staxa-ind
# or
yarn add staxa-ind

🔑 Authentication

You must have an API Key to use the Staxa Stock API service. The API Key is passed automatically in every request.

You can set your API Key via:

Environment Variable

Linux/macOS:

export STAXA_API_KEY=your-api-key-here

Windows (Command Prompt):

set STAXA_API_KEY=your-api-key-here

.env File

STAXA_API_KEY=your-api-key-herenpm u

🛠️ Usage

import StaxaStockService from 'staxa-ind';

// Optionally set your API Key (if not set in env)
process.env.STAXA_API_KEY = 'your-api-key-here';

(async () => {
  try {
    const price = await StaxaStockService.getStockPrice('TCS');
    console.log('TCS Stock Price:', price);
  } catch (err) {
    console.error('Error:', err.message);
  }
})();

📚 API Methods

getStockPrice(symbol)

Fetches the latest stock price for a given stock symbol.

const price = await StaxaStockService.getStockPrice('INFY');
console.log(price);

getBatchStockPrices(symbols)

Fetches stock prices for multiple symbols at once.

const prices = await StaxaStockService.getBatchStockPrices(['TCS', 'INFY', 'RELIANCE']);
console.log(prices);

getMutualFundNav(schemeCode)

Fetches the latest NAV for a given mutual fund.

const nav = await StaxaStockService.getMutualFundNav('120503');
console.log(nav);

🔒 Security Best Practices

• Always store your API keys in environment variables, never hardcode them into your app.
• Use .env files or secret managers if deploying to production.
• Restrict your API server access (IP restrictions, rate limiting).

🖥️ Backend Server Dependency

This package depends on a hosted Staxa Stock API server (FastAPI). Ensure you have deployed your own server or have access to a live one.

✨ Example Integration

Example React, Node.js, or backend apps can call:

import StaxaStockService from 'staxa-ind';

async function loadPrices() {
  const prices = await StaxaStockService.getBatchStockPrices(['TCS', 'INFY', 'ITC']);
  console.log('Live Prices:', prices);
}

👨‍💻 Development

Built with: Node.js
API Layer: Axios
Authentication: API Key (x-api-key header)

🛟 Support

Need help? Open an issue on GitHub or email the maintainer!

📜 License

MIT License