jyapystock 0.2.0

Fetch live and historical stock prices for Indian and American exchanges.

jyapystock

A Python library to fetch live and historical prices for Indian and American stocks.

Badges (overall + provider status):

Features

• Live price and historical price support
• Indian (NSE/BSE) and American (NYSE/NASDAQ) stocks
• Multiple data sources: yfinance (default), Alpha Vantage (optional)
• Multiple data sources: yfinance, Alpha Vantage (optional)
• Auto-fallback: if source is not provided (or set to None or 'auto'), the provider will try available free sources in order: yfinance first, then Alpha Vantage if an API key is available.
• Auto-fallback: if source is not provided (or set to None or 'auto'), the provider will try available free sources in order: yfinance first, then Alpha Vantage if an API key is available.
• Country: StockPriceProvider now requires a country argument. Supported values: India, USA.
  • For India, when using yfinance the provider will try symbol variants in this order when the symbol has no exchange suffix: SYMBOL.NS, SYMBOL.BO, then SYMBOL.

Installation

pip install -r requirements.txt

Installing as a library (recommended)

This project is intended to be used as a Python library. To install locally (editable/development):

# install editable for development
pip install -e .

# or install for local use
pip install .

For development and CI reproducibility, install pinned dev dependencies:

pip install -r requirements-dev.txt

Usage

from jyapystock.stock_price_provider import StockPriceProvider
provider = StockPriceProvider(country="USA", source="yfinance")
hist = provider.get_historical_price("AAPL", "2023-01-01", "2023-01-31")

from jyapystock.stock_price_provider import StockPriceProvider
provider = StockPriceProvider(country="India", source="yfinance")
price_in = provider.get_live_price("RELIANCE")
hist = provider.get_historical_price("RELIANCE", "2023-01-01", "2023-01-31")

# Using Alpha Vantage (requires API key)
# Auto mode (recommended): omit `source` or set `source=None` / `source='auto'`.
provider_av = StockPriceProvider(country="USA", source="alphavantage", alpha_vantage_api_key="YOUR_API_KEY")
price_av = provider_av.get_live_price("AAPL")
hist_av = provider_av.get_historical_price("AAPL", "2023-01-01", "2023-01-31")

Note: start and end parameters accepted by get_historical_price may be either string dates (e.g. "2023-01-01") or datetime objects. All providers normalize these inputs internally.

Supported Sources

• yfinance: Free, supports most global stocks
• Alpha Vantage: Free tier, requires API key, supports global stocks
• Polygon.io, IEX Cloud: Paid, US stocks (not implemented yet)

Testing

python -m unittest discover tests

License

MIT