OpenBB/website/content/platform/reference/fa/shrs.md

title, description

title	description
shrs	OpenBB Platform Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

shrs

Share Statistics.

shrs(symbol: Union[str, List[str]], provider: Literal[str] = fmp)

---

Parameters

Name	Type	Description	Default	Optional
symbol	Union[str, List[str]]	Symbol to get data for.		False
provider	Literal['fmp']	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.	fmp	True

---

Returns

OBBject
    results : List[ShareStatistics]
        Serializable results.

    provider : Optional[Literal['fmp']]
        Provider name.

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

    chart : Optional[Chart]
        Chart object.

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

---

Data

Name	Type	Description
symbol	str	Symbol to get data for.
date	date	A specific date to get data for.
free_float	float	Percentage of unrestricted shares of a publicly-traded company.
float_shares	float	Number of shares available for trading by the general public.
outstanding_shares	float	Total number of shares of a publicly-traded company.
source	str	Source of the received data.