Skip to main content

Unofficial Python Api for BSE India stock exchange

Project description

BseIndiaApi

An Unofficial Python Api for BSE India stock exchange.

Python version: >= 3.10

Install with PIP

pip install -U bse

Documentation

https://bennythadikaran.github.io/BseIndiaApi/

You might like stock-news built using BseIndiaApi. It helps to keep track of corporate announcements and actions on your portfolio.

Usage

Using with statement

from bse import BSE

with BSE(download_folder='./') as bse:
    scripCode = bse.getScripCode('tcs')  # 532540 bse scrip code

    data = bse.actions(scripcode=scripCode)

    ohlc = bse.quote(scripCode)  # Open, High, Low, LTP

or

from bse import BSE
from bse.constants import INDEX

bse = BSE(download_folder='./')

code = bse.getScripCode('tcs')  # 532540 bse scrip code

gainers = bse.gainers(by='index', name=INDEX.BSE500)

bse.exit()  # close the request session

Sample Responses

src/samples contain the sample responses from the various methods in JSON format.

The files are named after the corresponding method in src/BSE.py. Use it to understand the API response structure.

Example Folder

src/examples contains scripts that use the BSE.py.

To use the scripts download or clone the repo.

  • get_all_announcements.py: This file demonstrates how to paginate and get all announcements using BSE.announcements. It has step by step explanation of code.
  • actions.py: py actions.py infy to print the recent corporate actions. Nothing more.
  • advances.py: py advances.py to print the advance decline ratios for various bse Indexes.

You may also like my other repo: Stock-News - It uses BseIndiaApi and displays stock announcements, dividend, bonus/splits and upcoming results etc for your portfolio or watchlist stocks.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bse-2.0.0.tar.gz (32.8 kB view hashes)

Uploaded Source

Built Distribution

bse-2.0.0-py3-none-any.whl (25.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page