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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
import datetime
from typing import List, Literal, Optional, Union
from warnings import simplefilter, warn
from openbb_core.app.deprecation import OpenBBDeprecationWarning
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated, deprecated
class ROUTER_fixedincome_government(Container):
"""/fixedincome/government
treasury_rates
us_yield_curve
yield_curve
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def treasury_rates(
self,
start_date: Annotated[
Union[datetime.date, None, str],
OpenBBField(description="Start date of the data, in YYYY-MM-DD format."),
] = None,
end_date: Annotated[
Union[datetime.date, None, str],
OpenBBField(description="End date of the data, in YYYY-MM-DD format."),
] = None,
provider: Annotated[
Optional[Literal["federal_reserve", "fmp"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fmp."
),
] = None,
**kwargs
) -> OBBject:
"""Government Treasury Rates.
Parameters
----------
start_date : Union[datetime.date, None, str]
Start date of the data, in YYYY-MM-DD format.
end_date : Union[datetime.date, None, str]
End date of the data, in YYYY-MM-DD format.
provider : Optional[Literal['federal_reserve', 'fmp']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: federal_reserve, fmp.
Returns
-------
OBBject
results : List[TreasuryRates]
Serializable results.
provider : Optional[Literal['federal_reserve', 'fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
TreasuryRates
-------------
date : date
The date of the data.
week_4 : Optional[float]
4 week Treasury bills rate (secondary market).
month_1 : Optional[float]
1 month Treasury rate.
month_2 : Optional[float]
2 month Treasury rate.
month_3 : Optional[float]
3 month Treasury rate.
month_6 : Optional[float]
6 month Treasury rate.
year_1 : Optional[float]
1 year Treasury rate.
year_2 : Optional[float]
2 year Treasury rate.
year_3 : Optional[float]
3 year Treasury rate.
year_5 : Optional[float]
5 year Treasury rate.
year_7 : Optional[float]
7 year Treasury rate.
year_10 : Optional[float]
10 year Treasury rate.
year_20 : Optional[float]
20 year Treasury rate.
year_30 : Optional[float]
30 year Treasury rate.
Examples
--------
>>> from openbb import obb
>>> obb.fixedincome.government.treasury_rates(provider='fmp')
""" # noqa: E501
return self._run(
"/fixedincome/government/treasury_rates",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"fixedincome.government.treasury_rates",
("federal_reserve", "fmp"),
)
},
standard_params={
"start_date": start_date,
"end_date": end_date,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
@deprecated(
"This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.",
category=OpenBBDeprecationWarning,
)
def us_yield_curve(
self,
date: Annotated[
Union[datetime.date, None, str],
OpenBBField(
description="A specific date to get data for. Defaults to the most recent FRED entry."
),
] = None,
inflation_adjusted: Annotated[
Optional[bool], OpenBBField(description="Get inflation adjusted rates.")
] = False,
provider: Annotated[
Optional[Literal["fred"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred."
),
] = None,
**kwargs
) -> OBBject:
"""US Yield Curve. Get United States yield curve.
Parameters
----------
date : Union[datetime.date, None, str]
A specific date to get data for. Defaults to the most recent FRED entry.
inflation_adjusted : Optional[bool]
Get inflation adjusted rates.
provider : Optional[Literal['fred']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fred.
Returns
-------
OBBject
results : List[USYieldCurve]
Serializable results.
provider : Optional[Literal['fred']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
USYieldCurve
------------
maturity : float
Maturity of the treasury rate in years.
rate : float
Associated rate given in decimal form (0.05 is 5%)
Examples
--------
>>> from openbb import obb
>>> obb.fixedincome.government.us_yield_curve(provider='fred')
>>> obb.fixedincome.government.us_yield_curve(inflation_adjusted=True, provider='fred')
""" # noqa: E501
simplefilter("always", DeprecationWarning)
warn(
"This endpoint will be removed in a future version. Use, `/fixedincome/government/yield_curve`, instead. Deprecated in OpenBB Platform V4.2 to be removed in V4.4.",
category=DeprecationWarning,
stacklevel=2,
)
return self._run(
"/fixedincome/government/us_yield_curve",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"fixedincome.government.us_yield_curve",
("fred",),
)
},
standard_params={
"date": date,
"inflation_adjusted": inflation_adjusted,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def yield_curve(
self,
date: Annotated[
Union[str, None, List[Optional[str]]],
OpenBBField(
description="A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): econdb, federal_reserve, fmp, fred."
),
] = None,
provider: Annotated[
Optional[Literal["econdb", "federal_reserve", "fmp", "fred"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, federal_reserve, fmp, fred."
),
] = None,
**kwargs
) -> OBBject:
"""Get yield curve data by country and date.
Parameters
----------
date : Union[str, None, List[Optional[str]]]
A specific date to get data for. By default is the current data. Multiple comma separated items allowed for provider(s): econdb, federal_reserve, fmp, fred.
provider : Optional[Literal['econdb', 'federal_reserve', 'fmp', 'fred']]
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: econdb, federal_reserve, fmp, fred.
country : Literal['australia', 'canada', 'china', 'hong_kong', 'india', 'japan', 'mexico', 'new_zealand', 'russia', 'saudi_arabia', 'singapore', 'south_africa', 'south_korea', 'taiwan', 'thailand', 'united_kingdom', 'united_states']
The country to get data. New Zealand, Mexico, Singapore, and Thailand have only monthly data. The nearest date to the requested one will be used. (provider: econdb)
use_cache : bool
If true, cache the request for four hours. (provider: econdb)
yield_curve_type : Literal['nominal', 'real', 'breakeven', 'treasury_minus_fed_funds', 'corporate_spot', 'corporate_par']
Yield curve type. Nominal and Real Rates are available daily, others are monthly. The closest date to the requested date will be returned. (provider: fred)
Returns
-------
OBBject
results : List[YieldCurve]
Serializable results.
provider : Optional[Literal['econdb', 'federal_reserve', 'fmp', 'fred']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
YieldCurve
----------
date : Optional[date]
The date of the data.
maturity : str
Maturity length of the security.
rate : float
The yield as a normalized percent (0.05 is 5%)
Examples
--------
>>> from openbb import obb
>>> obb.fixedincome.government.yield_curve(provider='federal_reserve')
>>> obb.fixedincome.government.yield_curve(date='2023-05-01,2024-05-01', provider='fmp')
>>> obb.fixedincome.government.yield_curve(date='2023-05-01', country='united_kingdom', provider='econdb')
>>> obb.fixedincome.government.yield_curve(provider='fred', yield_curve_type='real', date='2023-05-01,2024-05-01')
""" # noqa: E501
return self._run(
"/fixedincome/government/yield_curve",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"fixedincome.government.yield_curve",
("econdb", "federal_reserve", "fmp", "fred"),
)
},
standard_params={
"date": date,
},
extra_params=kwargs,
info={
"date": {
"econdb": ["multiple_items_allowed"],
"federal_reserve": {"multiple_items_allowed": True},
"fmp": {"multiple_items_allowed": True},
"fred": {"multiple_items_allowed": True},
}
},
)
)
|
