Industry#
- class yfinance.Industry(key, session=None, region: str = 'US')#
Represents an industry within a sector.
- Parameters:
key (str) – The key identifier for the industry.
session (optional) – The session to use for requests.
region (str) – Yahoo region (ISO 3166-1 alpha-2 country code, e.g. “US”, “GB”, “FR”, “DE”, “JP”). Scopes top performing/growth company listings. Defaults to “US”.
Attributes
- key
Retrieves the key of the domain entity.
- Returns:
The unique key of the domain entity.
- Return type:
str
- name
Retrieves the name of the domain entity.
- Returns:
The name of the domain entity.
- Return type:
str
- overview
Retrieves the overview information of the domain entity.
- Returns:
A dictionary containing an overview of the domain entity.
- Return type:
Dict
- research_reports
Retrieves research reports related to the domain entity.
- Returns:
A list of research reports, where each report is a dictionary with metadata.
- Return type:
List[Dict[str, str]]
- sector_key
Returns the sector key of the industry.
- Returns:
The sector key.
- Return type:
str
- sector_name
Returns the sector name of the industry.
- Returns:
The sector name.
- Return type:
str
- symbol
Retrieves the symbol of the domain entity.
- Returns:
The symbol representing the domain entity.
- Return type:
str
- ticker
Retrieves a Ticker object based on the domain entity’s symbol.
- Returns:
A Ticker object associated with the domain entity.
- Return type:
- top_companies
Retrieves the top companies within the domain entity.
- Returns:
A DataFrame containing the top companies in the domain.
- Return type:
pandas.DataFrame
- top_growth_companies
Returns the top growth companies in the industry.
- Returns:
DataFrame containing top growth companies.
- Return type:
Optional[pd.DataFrame]
- top_performing_companies
Returns the top performing companies in the industry.
- Returns:
DataFrame containing top performing companies.
- Return type:
Optional[pd.DataFrame]
Methods
- __init__(key, session=None, region: str = 'US')
- Parameters:
key (str) – The key identifier for the industry.
session (optional) – The session to use for requests.
region (str) – Yahoo region (ISO 3166-1 alpha-2 country code, e.g. “US”, “GB”, “FR”, “DE”, “JP”). Scopes top performing/growth company listings. Defaults to “US”.