bse 0.0.4

Unofficial Python Api for BSE India stock exchange

BseIndiaApi

An unofficial python api for BSE India stock exchange.

Python version: >= 3.6

Install with PIP

pip install bse

Usage

Using with statement

from bse import BSE

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

    bse.getScripName('532540') # TCS

    data = bse.corporateActions(code)

    bse.quote(scrip_code) # Open, High, Low, LTP

or

from bse import BSE

bse = BSE()

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

bse.scripMeta(segment=bse.SEGMENT_EQUITY, status=bse.STATUS_ACTIVE, industry=bse.INDUSTRY_IT)

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.

Available methods

Help on class BSE in module BSE:

class BSE(builtins.object)
 |  Unofficial api for BSE India
 |
 |  Methods defined here:
 |
 |  __init__(self)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  advanceDecline(self)
 |      returns list of dictionary of advance decline values for each index
 |
 |  allAnnouncements(self, fromDate, toDate, category='-1')
 |      Returns all news items by date
 |
 |  allCorporateActions(self)
 |      returns list of dictionary of all corporate actions
 |
 |  announcements(self, scripcode, fromDate, toDate)
 |      Return Corporate announcements by scripcode and date
 |
 |  corporateActions(self, scripcode)
 |      Returns Corporate Actions by scripcode
 |
 |  exit(self)
 |
 |  getScripCode(self, scripname)
 |      returns bse symbol code for stock symbol name
 |
 |  getScripName(self, scripcode)
 |      returns stock symbol name for bse scrip code
 |
 |  listSecurities(self, industry='', scripcode='', group='', segment='Equity', status='Active')
 |      List all securities with their meta info or filter by industry etc.
 |
 |  near52WeekHighLow(self, scripcode='', indexcode='', group='')
 |      Returns stocks near 52 week highs and lows
 |
 |  quote(self, scripcode)
 |      Get OHLC quotes for given scripcode
 |
 |  scripMeta(self, scripcode='', segment='Equity', status='Active', group='', industry='')
 |      Return scrip meta info for all stocks or filtered by industry etc

CONSTANTS

# Corporate Announcement categories
CATEGORY_AGM = 'AGM/EGM'
CATEGORY_BOARD_MEETING = 'Board Meeting'
CATEGORY_UPDATE = 'Company Update'
CATEGORY_ACTION = 'Corp. Action'
CATEGORY_INSIDER = 'Insider Trading / SAST'
CATEGORY_NEW_LISTING = 'New Listing'
CATEGORY_RESULT = 'Result'
CATEGORY_OTHERS = 'Others'

# segments
SEGMENT_EQUITY = 'Equity'
SEGMENT_MF = 'MF'
SEGMENT_PREFERENCE_SHARES = 'Preference Shares'
SEGMENT_DEBENTURES_BONDS = 'Debentures and Bonds'
SEGMENT_EQUITY_INSTITUTIONAL = 'Equity - Institutional Series'
SEGMENT_COMMERCIAL_PAPERS = 'Commercial Papers'

# status
STATUS_ACTIVE = 'Active'
STATUS_SUSPENDED = 'Suspended'
STATUS_DELISTED = 'Delisted'

# industry / sector
INDUSTRY_AUTO = 'Automobile and Auto Components'
INDUSTRY_CAPITAL_GOODS = 'Capital Goods'
INDUSTRY_CHEMICALS = 'Chemicals'
INDUSTRY_CONSTRUCTION = 'Construction'
INDUSTRY_CONSTRUCTION_MATERIALS = 'Construction Materials'
INDUSTRY_CONSUMER_DURABLES = 'Consumer Durables'
INDUSTRY_CONSUMER_SERVICES = 'Consumer Services'
INDUSTRY_DIVERSIFIED = 'Diversified'
INDUSTRY_FMCG = 'Fast Moving Consumer Goods'
INDUSTRY_FIN_SERVICES = 'Financial Services'
INDUSTRY_FOREST_MATERIALS = 'Forest Materials'
INDUSTRY_IT = 'Information Technology'
INDUSTRY_MEDIA = 'Media, Entertainment & Publication'
INDUSTRY_METAL_MINING = 'Metals & Mining'
INDUSTRY_OIL_GAS = 'Oil, Gas & Consumable Fuels'
INDUSTRY_POWER = 'Power'
INDUSTRY_REALTY = 'Realty'
INDUSTRY_SERVICES = 'Services'
INDUSTRY_TELECOM = 'Telecommunication'
INDUSTRY_TEXTILES = 'Textiles'
INDUSTRY_UTILITIES = 'Utilities'

Example Folder

src/examples contains scripts that use the BSE.py. These are script i wrote some years back. All scripts incorporate color and fancy formatting to look good. 😄

To use the scripts download or clone the repo.

• ann.py: This is the only script i still use to date. It display all corporate announcements and corporate actions relating to your watchlist or portfolio.
  • To get started, store your watchlist symbols in a text file each symbol on a new line.
  • At first, execute ann.py passing the text file as an argument. py ann.py watchlist.txt. This will generate a watchlist.json file and print out all announcements and actions related to your watchlist.
  • Next time, simply execute py ann.py to see announcements for the day.
• news.py: news.py simply prints the last 10 announcements for a scrip.
  • Execute it as py news.py infy.
  • You can optionally limit the results by passing a number after the symbol.
  • py news.py infy 3. This returns the last 3 announcements.
• 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.