PyKap

KAP (Public Disclosure Platform) Documentation Wrapper for Capital Markets Board of Turkey and Borsa Istanbul Public Disclosures.

Installation

pip install pykap

From the repository:

pip install git+https://github.com/cemsinano/PyKap.git

Usage

To list all of the BIST Companies

from pykap.bist_company_list import bist_company_list
bist_company_list()

Get General Info for all of the BIST Companies

from pykap.get_bist_companies import get_bist_companies
get_bist_companies(online = False, output_format = 'pandas_df')

Default output format is pandas df (can be json or dict, as well).

online mode enables to get the most up-to-date company list from KAP's website. However, it takes time to parse. It is suggested to use online=False, unless otherwise is necessary.

Get General Info for a specific company

from pykap.get_general_info import get_general_info
get_general_info(tick='AKBNK')

BISTCompany Class:

from pykap.bist import BISTCompany
comp = BISTCompany(ticker='BIMAS') # initialize a BISTCompany object

When A BISTCompany object is initialized, some general information attributes (ticker, name, summary_page, city, auditor) get filled for this company.

Get Expected Disclosures List:

comp.get_expected_disclosure_list(count=10)

Get Historical Disclosures List:

# report_type: "4028328c594bfdca01594c0af9aa0057" or 'financial report' for financial reports
# report_type: "4028328d594c04f201594c5155dd0076" or "operation report" for operation reports  
report_type="operating report"
comp.get_historical_disclosure_list(fromdate = "2020-05-21",
                                    todate="2021-05-21", 
                                    disclosure_type="FR",
                                    subject=report_type)

Save Operating Review Report PDF File:

comp.save_operating_review(output_dir='OperatingReviews')

Check the self-specified output_dir directory for saved pdf document.

melcaliskan/pykap