Skip to main content

Equity Info


Implementation details​

Class names​

Model nameParameters classData class
EquityInfoEquityInfoQueryParamsEquityInfoData

Import Statement​

from openbb_core.provider.standard_models.equity_info import (
EquityInfoData,
EquityInfoQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
symbolUnion[str, List[str]]Symbol to get data for.False
providerLiteral['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

Data​

NameTypeDescription
symbolstrSymbol representing the entity requested in the data.
namestrCommon name of the company.
cikstrCentral Index Key (CIK) for the requested entity.
leistrLegal Entity Identifier assigned to the company.
legal_namestrOfficial legal name of the company.
stock_exchangestrStock exchange where the company is traded.
sicintStandard Industrial Classification code for the company.
short_descriptionstrShort description of the company.
long_descriptionstrLong description of the company.
ceostrChief Executive Officer of the company.
company_urlstrURL of the company's website.
business_addressstrAddress of the company's headquarters.
mailing_addressstrMailing address of the company.
business_phone_nostrPhone number of the company's headquarters.
hq_address1strAddress of the company's headquarters.
hq_address2strAddress of the company's headquarters.
hq_address_citystrCity of the company's headquarters.
hq_address_postal_codestrZip code of the company's headquarters.
hq_statestrState of the company's headquarters.
hq_countrystrCountry of the company's headquarters.
inc_statestrState in which the company is incorporated.
inc_countrystrCountry in which the company is incorporated.
employeesintNumber of employees working for the company.
entity_legal_formstrLegal form of the company.
entity_statusstrStatus of the company.
latest_filing_datedateDate of the company's latest filing.
irs_numberstrIRS number assigned to the company.
sectorstrSector in which the company operates.
industry_categorystrCategory of industry in which the company operates.
industry_groupstrGroup of industry in which the company operates.
templatestrTemplate used to standardize the company's financial statements.
standardized_activeboolWhether the company is active or not.
first_fundamental_datedateDate of the company's first fundamental.
last_fundamental_datedateDate of the company's last fundamental.
first_stock_price_datedateDate of the company's first stock price.
last_stock_price_datedateDate of the company's last stock price.