title, description
| title |
description |
| Price performance as a return, over different periods |
OpenBB Platform Data Model |
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Implementation details
Class names
| Model name |
Parameters class |
Data class |
PricePerformance |
PricePerformanceQueryParams |
PricePerformanceData |
Import Statement
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 |
| one_day |
float |
One-day return. |
| wtd |
float |
Week to date return. |
| one_week |
float |
One-week return. |
| mtd |
float |
Month to date return. |
| one_month |
float |
One-month return. |
| qtd |
float |
Quarter to date return. |
| three_month |
float |
Three-month return. |
| six_month |
float |
Six-month return. |
| ytd |
float |
Year to date return. |
| one_year |
float |
One-year return. |
| three_year |
float |
Three-year return. |
| five_year |
float |
Five-year return. |
| ten_year |
float |
Ten-year return. |
| max |
float |
Return from the beginning of the time series. |
|
|
|
| Name |
Type |
Description |
| one_day |
float |
One-day return. |
| wtd |
float |
Week to date return. |
| one_week |
float |
One-week return. |
| mtd |
float |
Month to date return. |
| one_month |
float |
One-month return. |
| qtd |
float |
Quarter to date return. |
| three_month |
float |
Three-month return. |
| six_month |
float |
Six-month return. |
| ytd |
float |
Year to date return. |
| one_year |
float |
One-year return. |
| three_year |
float |
Three-year return. |
| five_year |
float |
Five-year return. |
| ten_year |
float |
Ten-year return. |
| max |
float |
Return from the beginning of the time series. |
| symbol |
str |
The ticker symbol. |
|
|
|