Files
OpenBB/website/content/platform/data_models/PriceTarget.md
Henrique Joaquim 2d8c35df7a Data Models disposition on the website (#5538)
* pydantic v4

* flat structure

* md files

* Revert "md files"

This reverts commit bd2170e2ad.

* improve command descriptions

* nice title and description

* human readble data model names on left panel

* implementation details section

* content markdown files

* markdown versioned files

* showcase page

* updates

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-10-12 18:57:22 +02:00

2.9 KiB
Vendored

title, description
title description
Price Target OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';


Implementation details

Class names

Model name Parameters class Data class
PriceTarget PriceTargetQueryParams PriceTargetData

Import Statement

from openbb_provider.standard_models.price_target import (
PriceTargetData,
PriceTargetQueryParams,
)

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
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
with_grade bool Include upgrades and downgrades in the response. False True

Data

Name Type Description
symbol str Symbol to get data for.
published_date datetime Published date of the price target.
news_url str News URL of the price target.
news_title str News title of the price target.
analyst_name str Analyst name.
analyst_company str Analyst company.
price_target float Price target.
adj_price_target float Adjusted price target.
price_when_posted float Price when posted.
news_publisher str News publisher of the price target.
news_base_url str News base URL of the price target.
Name Type Description
symbol str Symbol to get data for.
published_date datetime Published date of the price target.
news_url str News URL of the price target.
news_title str News title of the price target.
analyst_name str Analyst name.
analyst_company str Analyst company.
price_target float Price target.
adj_price_target float Adjusted price target.
price_when_posted float Price when posted.
news_publisher str News publisher of the price target.
news_base_url str News base URL of the price target.
new_grade str New grade
previous_grade str Previous grade
grading_company str Grading company