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
|
"""Fixed Income Router."""
# pylint: disable=W0613:unused-argument
from openbb_core.app.model.command_context import CommandContext
from openbb_core.app.model.example import APIEx
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.provider_interface import (
ExtraParams,
ProviderChoices,
StandardParams,
)
from openbb_core.app.query import Query
from openbb_core.app.router import Router
from openbb_fixedincome.corporate.corporate_router import router as corporate_router
from openbb_fixedincome.government.government_router import router as government_router
from openbb_fixedincome.rate.rate_router import router as rate_router
from openbb_fixedincome.spreads.spreads_router import router as spreads_router
router = Router(prefix="", description="Fixed Income market data.")
router.include_router(rate_router)
router.include_router(spreads_router)
router.include_router(government_router)
router.include_router(corporate_router)
@router.command(
model="SOFR",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"period": "overnight", "provider": "fred"}),
],
)
async def sofr(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject: # type: ignore
"""Secured Overnight Financing Rate.
The Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of
borrowing cash overnight collateralizing by Treasury securities.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="BondIndices",
examples=[
APIEx(
description="The default state for FRED are series for constructing the US Corporate Bond Yield Curve.",
parameters={"provider": "fred"},
),
APIEx(
description="Multiple indices, from within the same 'category', can be requested.",
parameters={
"category": "high_yield",
"index": "us,europe,emerging",
"index_type": "total_return",
"provider": "fred",
},
),
APIEx(
description="From FRED, there are three main categories, 'high_yield', 'us', and 'emerging_markets'."
+ " Emerging markets is a broad category.",
parameters={
"category": "emerging_markets",
"index": "corporate,private_sector,public_sector",
"provider": "fred",
},
),
],
)
async def bond_indices(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject: # type: ignore
"""Bond Indices."""
return await OBBject.from_query(Query(**locals()))
|
