add some descriptions about provider

This commit is contained in:
Diogo Sousa
2023-08-01 19:48:30 +01:00
parent 35b5aea218
commit 96955b836b
5 changed files with 18 additions and 4 deletions

View File

@@ -6,7 +6,9 @@ from openbb_benzinga.models.stock_news import BenzingaStockNewsFetcher
benzinga_provider = Provider(
name="benzinga",
description="Provider for Benzinga.",
website="https://www.benzinga.com/",
description="""Benzinga is a financial data provider that offers an API
focused on information that moves the market.""",
required_credentials=["api_key"],
fetcher_dict={
"GlobalNews": BenzingaGlobalNewsFetcher,

View File

@@ -49,7 +49,9 @@ from openbb_fmp.models.treasury_rates import FMPTreasuryRatesFetcher
fmp_provider = Provider(
name="fmp",
description="Provider for FMP.",
website="https://financialmodelingprep.com/",
description="""Financial Modeling Prep is a new concept that informs you about
stock market information (news, currencies, and stock prices).""",
required_credentials=["api_key"],
fetcher_dict={
"KeyExecutives": FMPKeyExecutivesFetcher,

View File

@@ -5,7 +5,10 @@ from openbb_fred.models.cpi import FREDCPIFetcher
fred_provider = Provider(
name="fred",
description="Provider for FRED.",
website="https://fred.stlouisfed.org/",
description="""Federal Reserve Economic Data is a database maintained by the
Research division of the Federal Reserve Bank of St. Louis that has more than
816,000 economic time series from various sources.""",
required_credentials=["api_key"],
fetcher_dict={"CPI": FREDCPIFetcher},
)

View File

@@ -13,7 +13,10 @@ from openbb_polygon.models.stock_news import PolygonStockNewsFetcher
polygon_provider = Provider(
name="polygon",
description="Provider for Polygon.",
website="https://polygon.io/",
description="""The Polygon.io Stocks API provides REST endpoints that let you query
the latest market data from all US stock exchanges. You can also find data on
company financials, stock market holidays, corporate actions, and more.""",
required_credentials=["api_key"],
fetcher_dict={
"StockEOD": PolygonStockEODFetcher,

View File

@@ -13,6 +13,7 @@ class Provider:
self,
name: str,
description: str,
website: str,
fetcher_dict: Dict[str, Type[Fetcher]],
required_credentials: Optional[List[str]] = None,
) -> None:
@@ -24,6 +25,8 @@ class Provider:
Name of the provider.
description : str
Description of the provider.
website : str
Website of the provider.
fetcher_dict : Dict[str, Type[Fetcher]]
Dictionary of fetchers.
required_credentials : Optional[List[str]], optional
@@ -31,6 +34,7 @@ class Provider:
"""
self.name = name
self.description = description
self.website = website
self.fetcher_dict = fetcher_dict
if required_credentials is None:
self.required_credentials: List = []