Skip to main content

Share Price Index


Implementation details​

Class names​

Model nameParameters classData class
SharePriceIndexSharePriceIndexQueryParamsSharePriceIndexData

Import Statement​

from openbb_core.provider.standard_models.share_price_index import (
SharePriceIndexData,
SharePriceIndexQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
countryUnion[str, List[str]]The country to get data. Multiple items allowed for provider(s): oecd.united_statesTrue
frequencyLiteral['monthly', 'quarter', 'annual']The frequency of the data.monthlyTrue
start_dateUnion[date, str]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[date, str]End date of the data, in YYYY-MM-DD format.NoneTrue
providerLiteral['oecd']The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: oecd.NoneTrue

Data​

NameTypeDescription
datedateThe date of the data.
countrystr
valuefloatShare price index value.