Skip to main content

Share Statistics


Implementation details

Class names

Model nameParameters classData class
ShareStatisticsShareStatisticsQueryParamsShareStatisticsData

Import Statement

from openbb_core.provider.standard_models.share_statistics import (
ShareStatisticsData,
ShareStatisticsQueryParams,
)

Parameters

NameTypeDescriptionDefaultOptional
symbolUnion[str, List[str]]Symbol to get data for. Multiple items allowed for provider(s): yfinance.False
providerLiteral['fmp', 'intrinio', 'yfinance']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.fmpTrue

Data

NameTypeDescription
symbolstrSymbol representing the entity requested in the data.
datedateThe date of the data.
free_floatfloatPercentage of unrestricted shares of a publicly-traded company.
float_sharesfloatNumber of shares available for trading by the general public.
outstanding_sharesfloatTotal number of shares of a publicly-traded company.
sourcestrSource of the received data.