financialdatapy.stocklist module

This module retrieves stock lists.

class financialdatapy.stocklist.StockList[source]

Bases: ABC

Abstract class representing stock list of a stock exchange.

property stock_list: DataFrame
abstractmethod get_stock_list() → DataFrame[source]
class financialdatapy.stocklist.UsStockList[source]

Bases: StockList

Class representing stock list in US exchange.

get_stock_list() → DataFrame[source]

Get a list of companies CIK(Central Index Key) from SEC.

The list also contains ticker of a company.

Returns:

Dataframe with CIK, company name, and ticker for its columns.

Return type:

pandas.DataFrame

search_cik(symbol: str) → str[source]

Search CIK of specific a company.

Parameters:

symbol (str) – Company symbol to search.

Returns:

CIK of the company searching for.

Return type:

str

class financialdatapy.stocklist.KorStockList[source]

Bases: StockList

This class represents stock list in KOR exchange.

get_stock_list() → DataFrame[source]

Retrieve company code list of stocks listed in Korea Exchange.

Raises:

DartError – Failed in getting data from opendart.fss.or.kr.

Returns:

List of company codes.

Return type:

pandas.DataFrame

search_corp_code(symbol: str) → str[source]

Get corporate code from dart.fss.or.kr.

Parameters:

symbol (str) – Symbol of a company/stock.

Returns:

Corporate code.

Return type:

str

static search_stock_code(comp_name: str) → str[source]

Search stock code with company name in dart.fss.or.kr.

Parameters:

comp_name (str) – Company name.

Returns:

Stock code.

Return type:

str