share_price_index
Get the Share Price Index by country from the OECD Short-Term Economics Statistics.
Examples
from openbb import obb
obb.economy.share_price_index(provider='oecd')
# Multiple countries can be passed in as a list.
obb.economy.share_price_index(country='united_kingdom,germany', frequency='quarter', provider='oecd')
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 |
Returns
OBBject
results : List[SharePriceIndex]
Serializable results.
provider : Optional[Literal['oecd']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
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. |