diff --git a/openbb_providers/builtin_providers/polygon/balance_sheet.py b/openbb_providers/builtin_providers/polygon/balance_sheet.py index 08635a4ca66..624399a76c1 100644 --- a/openbb_providers/builtin_providers/polygon/balance_sheet.py +++ b/openbb_providers/builtin_providers/polygon/balance_sheet.py @@ -19,7 +19,7 @@ from builtin_providers.polygon.types import PolygonFundamentalQueryParams class PolygonBalanceSheetQueryParams(PolygonFundamentalQueryParams): - """Source: https://polygon.io/docs/stocks#!/get_vx_reference_financials""" + __doc__ = PolygonFundamentalQueryParams.__doc__ class PolygonBalanceSheetData(Data): diff --git a/openbb_providers/builtin_providers/polygon/cash_flow.py b/openbb_providers/builtin_providers/polygon/cash_flow.py index 7c1a4ccf3c3..3e20d1d019f 100644 --- a/openbb_providers/builtin_providers/polygon/cash_flow.py +++ b/openbb_providers/builtin_providers/polygon/cash_flow.py @@ -24,7 +24,7 @@ from builtin_providers.polygon.types import PolygonFundamentalQueryParams class PolygonCashFlowStatementQueryParams(PolygonFundamentalQueryParams): - """Source: https://polygon.io/docs/stocks#!/get_vx_reference_financials""" + __doc__ = PolygonFundamentalQueryParams.__doc__ class PolygonCashFlowStatementData(Data): @@ -34,7 +34,6 @@ class PolygonCashFlowStatementData(Data): filing_date: dateType acceptance_datetime: Optional[datetime] fiscal_period: Optional[str] = Field(alias="period") - # exchange_gain_losses: int net_cash_flow: int net_cash_flow_from_financing_activities: int net_cash_flow_from_investing_activities: int diff --git a/openbb_providers/builtin_providers/polygon/income_statement.py b/openbb_providers/builtin_providers/polygon/income_statement.py index d7863dcd85d..8bee11f3256 100644 --- a/openbb_providers/builtin_providers/polygon/income_statement.py +++ b/openbb_providers/builtin_providers/polygon/income_statement.py @@ -22,7 +22,7 @@ from builtin_providers.polygon.types import PolygonFundamentalQueryParams class PolygonIncomeStatementQueryParams(PolygonFundamentalQueryParams): - """Source: https://polygon.io/docs/stocks#!/get_vx_reference_financials""" + __doc__ = PolygonFundamentalQueryParams.__doc__ class PolygonIncomeStatementData(Data): diff --git a/openbb_providers/builtin_providers/polygon/types.py b/openbb_providers/builtin_providers/polygon/types.py index 88932c76750..e09d92d8b47 100644 --- a/openbb_providers/builtin_providers/polygon/types.py +++ b/openbb_providers/builtin_providers/polygon/types.py @@ -23,6 +23,54 @@ class Timespan(str, Enum): class PolygonFundamentalQueryParams(QueryParams): + """Polygon Fundamental QueryParams. + + Source: https://polygon.io/docs/stocks#!/get_vx_reference_financials + + Parameter + --------- + symbol : Optional[str] + The symbol of the company if no CIK is provided. + cik : Optional[str] + The CIK of the company if no symbol is provided. + company_name : Optional[str] + The name of the company. + company_name_search : Optional[str] + The name of the company to search. + sic : Optional[str] + The Standard Industrial Classification (SIC) of the company. + filing_date : Optional[date] + The filing date of the financial statement. + filing_date_lt : Optional[date] + The filing date less than the given date. + filing_date_lte : Optional[date] + The filing date less than or equal to the given date. + filing_date_gt : Optional[date] + The filing date greater than the given date. + filing_date_gte : Optional[date] + The filing date greater than or equal to the given date. + period_of_report_date : Optional[date] + The period of report date of the financial statement. + period_of_report_date_lt : Optional[date] + The period of report date less than the given date. + period_of_report_date_lte : Optional[date] + The period of report date less than or equal to the given date. + period_of_report_date_gt : Optional[date] + The period of report date greater than the given date. + period_of_report_date_gte : Optional[date] + The period of report date greater than or equal to the given date. + timeframe : Optional[Literal["annual", "quarterly", "ttm"]] + The timeframe of the financial statement. + include_sources : Optional[bool] + Whether to include the sources of the financial statement. + order : Optional[Literal["asc", "desc"]] + The order of the financial statement. + limit : Optional[PositiveInt] + The limit of the financial statement. + sort : Optional[Literal["filing_date", "period_of_report_date"]] + The sort of the financial statement. + """ + ticker: Optional[str] = Field(alias="symbol") cik: Optional[str] company_name: Optional[str] diff --git a/openbb_sdk/openbb_sdk_core/openbb_sdk_core/app/static/package_builder.py b/openbb_sdk/openbb_sdk_core/openbb_sdk_core/app/static/package_builder.py index 6fd68b38f3d..a01050b73b4 100644 --- a/openbb_sdk/openbb_sdk_core/openbb_sdk_core/app/static/package_builder.py +++ b/openbb_sdk/openbb_sdk_core/openbb_sdk_core/app/static/package_builder.py @@ -356,6 +356,7 @@ class DocstringGenerator: available_providers = ", ".join(docstring_mapping.keys()) available_providers = available_providers.replace("openbb, ", "") + available_providers = available_providers.replace("openbb", "") docstring += f"\n\nAvailable providers: {available_providers}\n"