Files
OpenBB/website/content/platform/data_models/PricePerformance.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774)
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

2.5 KiB
Vendored

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

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

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.