profile

Equity Info. Get general price and performance metrics of a stock.

Example

from openbb import obb
obb.equity.profile(symbol="AAPL")

---

Parameters

• Standard

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for.		False
provider	Literal['cboe', 'intrinio']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	"cboe"	True

---

Returns

OBBject
    results : List[EquityInfo]
        Serializable results.

    provider : Optional[Literal['cboe', 'intrinio']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

---

Data

• Standard
• cboe
• intrinio

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Common name of the company.
cik	str	Central Index Key (CIK) for the requested entity.
lei	str	Legal Entity Identifier assigned to the company.
legal_name	str	Official legal name of the company.
stock_exchange	str	Stock exchange where the company is traded.
sic	int	Standard Industrial Classification code for the company.
short_description	str	Short description of the company.
long_description	str	Long description of the company.
ceo	str	Chief Executive Officer of the company.
company_url	str	URL of the company's website.
business_address	str	Address of the company's headquarters.
mailing_address	str	Mailing address of the company.
business_phone_no	str	Phone number of the company's headquarters.
hq_address1	str	Address of the company's headquarters.
hq_address2	str	Address of the company's headquarters.
hq_address_city	str	City of the company's headquarters.
hq_address_postal_code	str	Zip code of the company's headquarters.
hq_state	str	State of the company's headquarters.
hq_country	str	Country of the company's headquarters.
inc_state	str	State in which the company is incorporated.
inc_country	str	Country in which the company is incorporated.
employees	int	Number of employees working for the company.
entity_legal_form	str	Legal form of the company.
entity_status	str	Status of the company.
latest_filing_date	date	Date of the company's latest filing.
irs_number	str	IRS number assigned to the company.
sector	str	Sector in which the company operates.
industry_category	str	Category of industry in which the company operates.
industry_group	str	Group of industry in which the company operates.
template	str	Template used to standardize the company's financial statements.
standardized_active	bool	Whether the company is active or not.
first_fundamental_date	date	Date of the company's first fundamental.
last_fundamental_date	date	Date of the company's last fundamental.
first_stock_price_date	date	Date of the company's first stock price.
last_stock_price_date	date	Date of the company's last stock price.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Common name of the company.
cik	str	Central Index Key (CIK) for the requested entity.
lei	str	Legal Entity Identifier assigned to the company.
legal_name	str	Official legal name of the company.
stock_exchange	str	Stock exchange where the company is traded.
sic	int	Standard Industrial Classification code for the company.
short_description	str	Short description of the company.
long_description	str	Long description of the company.
ceo	str	Chief Executive Officer of the company.
company_url	str	URL of the company's website.
business_address	str	Address of the company's headquarters.
mailing_address	str	Mailing address of the company.
business_phone_no	str	Phone number of the company's headquarters.
hq_address1	str	Address of the company's headquarters.
hq_address2	str	Address of the company's headquarters.
hq_address_city	str	City of the company's headquarters.
hq_address_postal_code	str	Zip code of the company's headquarters.
hq_state	str	State of the company's headquarters.
hq_country	str	Country of the company's headquarters.
inc_state	str	State in which the company is incorporated.
inc_country	str	Country in which the company is incorporated.
employees	int	Number of employees working for the company.
entity_legal_form	str	Legal form of the company.
entity_status	str	Status of the company.
latest_filing_date	date	Date of the company's latest filing.
irs_number	str	IRS number assigned to the company.
sector	str	Sector in which the company operates.
industry_category	str	Category of industry in which the company operates.
industry_group	str	Group of industry in which the company operates.
template	str	Template used to standardize the company's financial statements.
standardized_active	bool	Whether the company is active or not.
first_fundamental_date	date	Date of the company's first fundamental.
last_fundamental_date	date	Date of the company's last fundamental.
first_stock_price_date	date	Date of the company's first stock price.
last_stock_price_date	date	Date of the company's last stock price.
type	str	Type of asset.
exchange_id	int	The Exchange ID number.
tick	str	Whether the last sale was an up or down tick.
bid	float	Current bid price.
bid_size	float	Bid lot size.
ask	float	Current ask price.
ask_size	float	Ask lot size.
volume	float	Stock volume for the current trading day.
iv30	float	The 30-day implied volatility of the stock.
iv30_change	float	Change in 30-day implied volatility of the stock.
last_trade_timestamp	datetime	Last trade timestamp for the stock.
iv30_annual_high	float	The 1-year high of implied volatility.
hv30_annual_high	float	The 1-year high of realized volatility.
iv30_annual_low	float	The 1-year low of implied volatility.
hv30_annual_low	float	The 1-year low of realized volatility.
iv60_annual_high	float	The 60-day high of implied volatility.
hv60_annual_high	float	The 60-day high of realized volatility.
iv60_annual_low	float	The 60-day low of implied volatility.
hv60_annual_low	float	The 60-day low of realized volatility.
iv90_annual_high	float	The 90-day high of implied volatility.
hv90_annual_high	float	The 90-day high of realized volatility.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Common name of the company.
cik	str	Central Index Key (CIK) for the requested entity.
lei	str	Legal Entity Identifier assigned to the company.
legal_name	str	Official legal name of the company.
stock_exchange	str	Stock exchange where the company is traded.
sic	int	Standard Industrial Classification code for the company.
short_description	str	Short description of the company.
long_description	str	Long description of the company.
ceo	str	Chief Executive Officer of the company.
company_url	str	URL of the company's website.
business_address	str	Address of the company's headquarters.
mailing_address	str	Mailing address of the company.
business_phone_no	str	Phone number of the company's headquarters.
hq_address1	str	Address of the company's headquarters.
hq_address2	str	Address of the company's headquarters.
hq_address_city	str	City of the company's headquarters.
hq_address_postal_code	str	Zip code of the company's headquarters.
hq_state	str	State of the company's headquarters.
hq_country	str	Country of the company's headquarters.
inc_state	str	State in which the company is incorporated.
inc_country	str	Country in which the company is incorporated.
employees	int	Number of employees working for the company.
entity_legal_form	str	Legal form of the company.
entity_status	str	Status of the company.
latest_filing_date	date	Date of the company's latest filing.
irs_number	str	IRS number assigned to the company.
sector	str	Sector in which the company operates.
industry_category	str	Category of industry in which the company operates.
industry_group	str	Group of industry in which the company operates.
template	str	Template used to standardize the company's financial statements.
standardized_active	bool	Whether the company is active or not.
first_fundamental_date	date	Date of the company's first fundamental.
last_fundamental_date	date	Date of the company's last fundamental.
first_stock_price_date	date	Date of the company's first stock price.
last_stock_price_date	date	Date of the company's last stock price.
id	str	Intrinio ID for the company.
thea_enabled	bool	Whether the company has been enabled for Thea.