Finra Equity Info
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FinraEquityInfo | FinraEquityInfoQueryParams | FinraEquityInfoData |
Import Statement
from openbb_core.provider.standard_models. import (
FinraEquityInfoData,
FinraEquityInfoQueryParams,
)
Parameters
- standard
- finra
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finra.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): finra.
Data
- standard
- finra
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Common name of the company.
cik: str | None
Central Index Key (CIK) for the requested entity.
cusip: str | None
CUSIP identifier for the company.
isin: str | None
International Securities Identification Number.
lei: str | None
Legal Entity Identifier assigned to the company.
legal_name: str | None
Official legal name of the company.
stock_exchange: str | None
Stock exchange where the company is traded.
sic: int | None
Standard Industrial Classification code for the company.
short_description: str | None
Short description of the company.
long_description: str | None
Long description of the company.
ceo: str | None
Chief Executive Officer of the company.
company_url: str | None
URL of the company's website.
business_address: str | None
Address of the company's headquarters.
mailing_address: str | None
Mailing address of the company.
business_phone_no: str | None
Phone number of the company's headquarters.
hq_address1: str | None
Address of the company's headquarters.
hq_address2: str | None
Address of the company's headquarters.
hq_address_city: str | None
City of the company's headquarters.
hq_address_postal_code: str | None
Zip code of the company's headquarters.
hq_state: str | None
State of the company's headquarters.
hq_country: str | None
Country of the company's headquarters.
inc_state: str | None
State in which the company is incorporated.
inc_country: str | None
Country in which the company is incorporated.
employees: int | None
Number of employees working for the company.
entity_legal_form: str | None
Legal form of the company.
entity_status: str | None
Status of the company.
latest_filing_date: date | None
Date of the company's latest filing.
irs_number: str | None
IRS number assigned to the company.
sector: str | None
Sector in which the company operates.
industry_category: str | None
Category of industry in which the company operates.
industry_group: str | None
Group of industry in which the company operates.
template: str | None
Template used to standardize the company's financial statements.
standardized_active: bool | None
Whether the company is active or not.
first_fundamental_date: date | None
Date of the company's first fundamental.
last_fundamental_date: date | None
Date of the company's last fundamental.
first_stock_price_date: date | None
Date of the company's first stock price.
last_stock_price_date: date | None
Date of the company's last stock price.
symbol: str
Symbol representing the entity requested in the data.
name: str | None
Common name of the company.
cik: str | None
Central Index Key (CIK) for the requested entity.
cusip: str | None
CUSIP identifier for the company.
isin: str | None
International Securities Identification Number.
lei: str | None
Legal Entity Identifier assigned to the company.
legal_name: str | None
Official legal name of the company.
stock_exchange: str | None
Stock exchange where the company is traded.
sic: int | None
Standard Industrial Classification code for the company.
short_description: str | None
Short description of the company.
long_description: str | None
Long description of the company.
ceo: str | None
Chief Executive Officer of the company.
company_url: str | None
URL of the company's website.
business_address: str | None
Address of the company's headquarters.
mailing_address: str | None
Mailing address of the company.
business_phone_no: str | None
Phone number of the company's headquarters.
hq_address1: str | None
Address of the company's headquarters.
hq_address2: str | None
Address of the company's headquarters.
hq_address_city: str | None
City of the company's headquarters.
hq_address_postal_code: str | None
Zip code of the company's headquarters.
hq_state: str | None
State of the company's headquarters.
hq_country: str | None
Country of the company's headquarters.
inc_state: str | None
State in which the company is incorporated.
inc_country: str | None
Country in which the company is incorporated.
employees: int | None
Number of employees working for the company.
entity_legal_form: str | None
Legal form of the company.
entity_status: str | None
Status of the company.
latest_filing_date: date | None
Date of the company's latest filing.
irs_number: str | None
IRS number assigned to the company.
sector: str | None
Sector in which the company operates.
industry_category: str | None
Category of industry in which the company operates.
industry_group: str | None
Group of industry in which the company operates.
template: str | None
Template used to standardize the company's financial statements.
standardized_active: bool | None
Whether the company is active or not.
first_fundamental_date: date | None
Date of the company's first fundamental.
last_fundamental_date: date | None
Date of the company's last fundamental.
first_stock_price_date: date | None
Date of the company's first stock price.
last_stock_price_date: date | None
Date of the company's last stock price.
security_type: str | None
The Morningstar security type - Stock, ETF, Closed-End Fund, Open-End Fund, or Index.
security_description: str | None
The share class, or the Morningstar category of a fund.
security_id: str | None
The Morningstar security id.
performance_id: str | None
The Morningstar performance id.
company_id: str | None
The Morningstar company or fund id.
quote_symbol: str | None
The real-time quote key - composite market, type, and symbol.
exchange_name: str | None
The name of the listing exchange.
region: str | None
The ISO 3166 alpha-3 code of the listing region.
domicile: str | None
The ISO 3166 alpha-3 code of the domicile.
currency: str | None
The trading currency.
is_adr: bool | None
Whether the security is a depositary receipt.
ipo_date: date | None
The IPO date of a stock, or the inception date of a fund.
fiscal_year_end_month: str | None
The month the fiscal year ends.
gics_sector: str | None
The GICS sector.
gics_industry: str | None
The GICS industry.
gics_sub_industry: str | None
The GICS sub-industry.
fund_category: str | None
The Morningstar category of a fund.
last_price: float | None
The last closing price.
last_price_date: date | None
The date of the last closing price.
price_one_week_ago: float | None
The closing price one week before.
nav: float | None
The net asset value per share of a fund.
year_high: float | None
The 52-week high.
year_high_date: date | None
The date of the 52-week high.
year_low: float | None
The 52-week low.
year_low_date: date | None
The date of the 52-week low.
shares_outstanding: float | None
The number of shares outstanding.
market_cap: float | None
The market capitalization.
net_assets: float | None
The total net assets of a fund.
average_volume: float | None
The average daily share volume.
last_dividend: float | None
The most recent dividend per share.
trailing_dividend: float | None
The dividends per share over the trailing year.
dividend_yield: float | None
The trailing dividend yield, as a percent.
forward_dividend_yield: float | None
The forward dividend yield, as a percent.
dividend_frequency: str | None
How often the dividend is paid.
ex_dividend_date: date | None
The ex-date of the most recent dividend.
dividend_declaration_date: date | None
The declaration date of the most recent dividend.
dividend_payment_date: date | None
The payment date of the most recent dividend.
eps_ttm: float | None
The trailing twelve-month earnings per share.
pe_ratio: float | None
The trailing price-to-earnings ratio.
price_to_book: float | None
The price-to-book ratio.
price_to_sales: float | None
The price-to-sales ratio.
price_to_cash_flow: float | None
The price-to-cash-flow ratio.
price_to_free_cash_flow: float | None
The price-to-free-cash-flow ratio.
expense_ratio: float | None
The net expense ratio of a fund, as a percent.
morningstar_rating: int | None
The Morningstar star rating, from 1 to 5.
valuation: str | None
The Morningstar quantitative valuation.
volatility_1y: float | None
The standard deviation of returns over one year, as a percent.
volatility_3y: float | None
The standard deviation of returns over three years, as a percent.
url: str | None
The security's page on the FINRA Market Data Center.