Share Price Index
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
SharePriceIndex | SharePriceIndexQueryParams | SharePriceIndexData |
Import Statement
from openbb_core.provider.standard_models.share_price_index import (
SharePriceIndexData,
SharePriceIndexQueryParams,
)
Parameters
- standard
- oecd
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[str, List[str]] | The country to get data. Multiple items allowed for provider(s): oecd. | united_states | True |
frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | str | The country to get data. | united_states | True |
frequency | Literal['monthly', 'quarter', 'annual'] | The frequency of the data. | monthly | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
Data
- standard
- oecd
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
country | str | |
value | float | Share price index value. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
country | str | |
value | float | Share price index value. |