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
|
"""ETF Equity Exposure Standard Model."""
from typing import Optional, Union
from pydantic import Field, field_validator
from openbb_core.provider.abstract.data import Data
from openbb_core.provider.abstract.query_params import QueryParams
from openbb_core.provider.utils.descriptions import QUERY_DESCRIPTIONS
class EtfEquityExposureQueryParams(QueryParams):
"""ETF Equity Exposure Query Params."""
symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", "") + " (Stock)")
@field_validator("symbol")
@classmethod
def to_upper(cls, v: str) -> str:
"""Convert field to uppercase."""
return v.upper()
class EtfEquityExposureData(Data):
"""ETF Equity Exposure Data."""
equity_symbol: str = Field(description="The symbol of the equity requested.")
etf_symbol: str = Field(
description="The symbol of the ETF with exposure to the requested equity."
)
shares: Optional[float] = Field(
default=None,
description="The number of shares held in the ETF.",
)
weight: Optional[float] = Field(
default=None,
description="The weight of the equity in the ETF, as a normalized percent.",
json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100},
)
market_value: Optional[Union[int, float]] = Field(
default=None,
description="The market value of the equity position in the ETF.",
)
|
