sec-cik-mapper 1.0.0

Installation

Install and update this package using pip:

$ pip install -U sec-cik-mapper

Basic Usage

>>> from sec_cik_mapper import CIKMapper
>>> from pathlib import Path

# Initialize a CIK mapper instance
>>> cikMapper = CIKMapper()

# Save full CIK, ticker, and company name mapping to a CSV file
>>> csv_path = Path("cik_mapping.csv")
>>> cikMapper.save_metadata_to_csv(csv_path)

# Get a dictionary mapping CIK to a list of tickers
>>> cikMapper.get_cik_to_ticker_mapping()
{'0000320193': ['AAPL'], '0000789019': ['MSFT'], '0001652044': ['GOOG', 'GOOGL'], '0001018724': ['AMZN'], '0001326801': ['FB'], '0001318605': ['TSLA'], '0000040545': ['GE'], '0001067983': ['BRK-A', 'BRK-B'], '0001046179': ['TSM'], '0000019617': ['JPM', 'JPM-PC', 'JPM-PD', 'JPM-PJ', 'JPM-PK', 'JPM-PL', 'JPM-PM', 'AMJ'], ...}

# Get a dictionary mapping ticker to CIK
>>> cikMapper.get_ticker_to_cik_mapping()
{'AAPL': '0000320193', 'MSFT': '0000789019', 'GOOG': '0001652044', 'AMZN': '0001018724', 'FB': '0001326801', 'TSLA': '0001318605', 'GE': '0000040545', 'BRK-A': '0001067983', 'TSM': '0001046179', 'JPM': '0000019617', ...}

# Get a dictionary mapping CIK to company name
>>> cikMapper.get_cik_to_company_name_mapping()
{'0000320193': 'Apple Inc.', '0000789019': 'Microsoft Corp', '0001652044': 'Alphabet Inc.', '0001018724': 'Amazon Com Inc', '0001326801': 'Meta Platforms, Inc.', '0001318605': 'Tesla, Inc.', '0000040545': 'General Electric Co', '0001067983': 'Berkshire Hathaway Inc', '0001046179': 'Taiwan Semiconductor Manufacturing Co Ltd', '0000019617': 'Jpmorgan Chase & Co', ...}

# Get a dictionary mapping ticker to company name
>>> cikMapper.get_ticker_to_company_name_mapping()
{'AAPL': 'Apple Inc.', 'MSFT': 'Microsoft Corp', 'GOOG': 'Alphabet Inc.', 'AMZN': 'Amazon Com Inc', 'FB': 'Meta Platforms, Inc.', 'TSLA': 'Tesla, Inc.', 'GE': 'General Electric Co', 'BRK-A': 'Berkshire Hathaway Inc', 'TSM': 'Taiwan Semiconductor Manufacturing Co Ltd', 'JPM': 'Jpmorgan Chase & Co', ...}