1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
"""Analyst Estimates Standard Model."""
from datetime import date as dateType
from typing import List, Literal, Optional, Set, Union
from pydantic import Field, field_validator
from openbb_core.provider.abstract.data import Data, ForceInt
from openbb_core.provider.abstract.query_params import QueryParams
from openbb_core.provider.utils.descriptions import (
DATA_DESCRIPTIONS,
QUERY_DESCRIPTIONS,
)
class AnalystEstimatesQueryParams(QueryParams):
"""Analyst Estimates Query."""
symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", ""))
period: Literal["quarter", "annual"] = Field(
default="annual", description=QUERY_DESCRIPTIONS.get("period", "")
)
limit: int = Field(default=30, description=QUERY_DESCRIPTIONS.get("limit", ""))
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
def to_upper(cls, v: str) -> str:
"""Convert field to uppercase."""
return v.upper()
@field_validator("period", mode="before", check_fields=False)
@classmethod
def to_lower(cls, v: Optional[str]) -> Optional[str]:
"""Convert field to lowercase."""
return v.lower() if v else v
class AnalystEstimatesData(Data):
"""Analyst Estimates data."""
symbol: str = Field(description=DATA_DESCRIPTIONS.get("symbol", ""))
date: dateType = Field(description=DATA_DESCRIPTIONS.get("date", ""))
estimated_revenue_low: ForceInt = Field(description="Estimated revenue low.")
estimated_revenue_high: ForceInt = Field(description="Estimated revenue high.")
estimated_revenue_avg: ForceInt = Field(description="Estimated revenue average.")
estimated_ebitda_low: ForceInt = Field(description="Estimated EBITDA low.")
estimated_ebitda_high: ForceInt = Field(description="Estimated EBITDA high.")
estimated_ebitda_avg: ForceInt = Field(description="Estimated EBITDA average.")
estimated_ebit_low: ForceInt = Field(description="Estimated EBIT low.")
estimated_ebit_high: ForceInt = Field(description="Estimated EBIT high.")
estimated_ebit_avg: ForceInt = Field(description="Estimated EBIT average.")
estimated_net_income_low: ForceInt = Field(description="Estimated net income low.")
estimated_net_income_high: ForceInt = Field(
description="Estimated net income high."
)
estimated_net_income_avg: ForceInt = Field(
description="Estimated net income average."
)
estimated_sga_expense_low: ForceInt = Field(
description="Estimated SGA expense low."
)
estimated_sga_expense_high: ForceInt = Field(
description="Estimated SGA expense high."
)
estimated_sga_expense_avg: ForceInt = Field(
description="Estimated SGA expense average."
)
estimated_eps_avg: float = Field(description="Estimated EPS average.")
estimated_eps_high: float = Field(description="Estimated EPS high.")
estimated_eps_low: float = Field(description="Estimated EPS low.")
number_analyst_estimated_revenue: ForceInt = Field(
description="Number of analysts who estimated revenue."
)
number_analysts_estimated_eps: ForceInt = Field(
description="Number of analysts who estimated EPS."
)
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
def to_upper(cls, v: Union[str, List[str], Set[str]]):
"""Convert field to uppercase."""
if isinstance(v, str):
return v.upper()
return ",".join([symbol.upper() for symbol in list(v)]) if v else None
|
