summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDanglewood <85772166+deeleeramone@users.noreply.github.com>2024-04-11 02:18:22 -0700
committerGitHub <noreply@github.com>2024-04-11 09:18:22 +0000
commit3fc6acb774e24551f1bedbb564a9cdad06f5a4a6 (patch)
treecc0ac44ab5af89bda82f1fb76690ebc001ed6864
parent1c26d24e95252797d35fd71bb0df99dccdacf79d (diff)
undocumented benzinga fields in response (#6304)
-rw-r--r--openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py66
1 files changed, 66 insertions, 0 deletions
diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py
index 27781df35eb..1d9424309a0 100644
--- a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py
+++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py
@@ -145,6 +145,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="1m_stdev",
)
+ smart_score_1m: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last month.",
+ alias="1m_smart_score",
+ )
+ success_rate_1m: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="1m_success_rate",
+ )
gain_count_3m: Optional[int] = Field(
default=None,
description="The number of ratings that have gained value over the last 3 months",
@@ -169,6 +180,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="3m_stdev",
)
+ smart_score_3m: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last 3 months.",
+ alias="3m_smart_score",
+ )
+ success_rate_3m: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="3m_success_rate",
+ )
gain_count_6m: Optional[int] = Field(
default=None,
description="The number of ratings that have gained value over the last 6 months",
@@ -217,6 +239,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="9m_stdev",
)
+ smart_score_9m: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last 9 months.",
+ alias="9m_smart_score",
+ )
+ success_rate_9m: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="9m_success_rate",
+ )
gain_count_1y: Optional[int] = Field(
default=None,
description="The number of ratings that have gained value over the last 1 year",
@@ -241,6 +274,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="1y_stdev",
)
+ smart_score_1y: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last 1 year.",
+ alias="1y_smart_score",
+ )
+ success_rate_1y: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="1y_success_rate",
+ )
gain_count_2y: Optional[int] = Field(
default=None,
description="The number of ratings that have gained value over the last 2 years",
@@ -265,6 +309,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="2y_stdev",
)
+ smart_score_2y: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last 3 years.",
+ alias="2y_smart_score",
+ )
+ success_rate_2y: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="2y_success_rate",
+ )
gain_count_3y: Optional[int] = Field(
default=None,
description="The number of ratings that have gained value over the last 3 years",
@@ -289,6 +344,17 @@ class BenzingaAnalystSearchData(AnalystSearchData):
json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
alias="3y_stdev",
)
+ smart_score_3y: Optional[float] = Field(
+ default=None,
+ description="A weighted average smart score over the last 3 years.",
+ alias="3y_smart_score",
+ )
+ success_rate_3y: Optional[float] = Field(
+ default=None,
+ description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years",
+ json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100},
+ alias="3y_success_rate",
+ )
@field_validator("last_updated", mode="before", check_fields=False)
@classmethod