mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-12 12:22:35 +00:00
* pydantic v4
* flat structure
* md files
* Revert "md files"
This reverts commit bd2170e2ad.
* improve command descriptions
* nice title and description
* human readble data model names on left panel
* implementation details section
* content markdown files
* markdown versioned files
* showcase page
* updates
---------
Co-authored-by: tehcoderer <me@tehcoderer.com>
1.5 KiB
Vendored
1.5 KiB
Vendored
title, description
| title | description |
|---|---|
| Share Statistics | OpenBB Platform Data Model |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ShareStatistics |
ShareStatisticsQueryParams |
ShareStatisticsData |
Import Statement
from openbb_provider.standard_models.share_statistics import (
ShareStatisticsData,
ShareStatisticsQueryParams,
)
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 |
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. |