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
|
"""Bond Indices Standard Model."""
from datetime import (
date as dateType,
)
from typing import Literal, Optional
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 (
DATA_DESCRIPTIONS,
QUERY_DESCRIPTIONS,
)
class BondIndicesQueryParams(QueryParams):
"""Bond Indices Query."""
start_date: Optional[dateType] = Field(
default=None,
description=QUERY_DESCRIPTIONS.get("start_date", ""),
)
end_date: Optional[dateType] = Field(
default=None,
description=QUERY_DESCRIPTIONS.get("end_date", ""),
)
index_type: Literal["yield", "yield_to_worst", "total_return", "oas"] = Field(
default="yield",
description="The type of series. OAS is the option-adjusted spread. Default is yield.",
json_schema_extra={
"choices": ["yield", "yield_to_worst", "total_return", "oas"]
},
)
@field_validator("index_type", 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 BondIndicesData(Data):
"""Bond Indices Data."""
date: dateType = Field(description=DATA_DESCRIPTIONS.get("date", ""))
symbol: Optional[str] = Field(
default=None,
description=DATA_DESCRIPTIONS.get("symbol", ""),
)
value: float = Field(description="Index values.")
|
