Skip to main content

Price Performance


Implementation details​

Class names​

Model nameParameters classData class
PricePerformancePricePerformanceQueryParamsPricePerformanceData

Import Statement​

from openbb_core.provider.standard_models. import (
PricePerformanceData,
PricePerformanceQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
symbolUnion[str, List[str]]Symbol to get data for. Multiple items allowed for provider(s): finviz, fmp.False
providerLiteral['finviz', 'fmp']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'finviz' if there is no default.finvizTrue

Data​

NameTypeDescription
one_dayfloatOne-day return.
wtdfloatWeek to date return.
one_weekfloatOne-week return.
mtdfloatMonth to date return.
one_monthfloatOne-month return.
qtdfloatQuarter to date return.
three_monthfloatThree-month return.
six_monthfloatSix-month return.
ytdfloatYear to date return.
one_yearfloatOne-year return.
three_yearfloatThree-year return.
five_yearfloatFive-year return.
ten_yearfloatTen-year return.
maxfloatReturn from the beginning of the time series.