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
|
"""Fixed Income Corporate Router."""
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
router = Router(prefix="/corporate")
# pylint: disable=unused-argument
@router.command(
model="ICEBofA",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"index_type": "yield_to_worst", "provider": "fred"}),
],
)
async def ice_bofa(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""ICE BofA US Corporate Bond Indices.
The ICE BofA US Corporate Index tracks the performance of US dollar denominated investment grade corporate debt
publicly issued in the US domestic market. Qualifying securities must have an investment grade rating (based on an
average of Moody’s, S&P and Fitch), at least 18 months to final maturity at the time of issuance, at least one year
remaining term to final maturity as of the rebalance date, a fixed coupon schedule and a minimum amount
outstanding of $250 million. The ICE BofA US Corporate Index is a component of the US Corporate Master Index.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="MoodyCorporateBondIndex",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"index_type": "baa", "provider": "fred"}),
],
)
async def moody(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Moody Corporate Bond Index.
Moody's Aaa and Baa are investment bonds that acts as an index of
the performance of all bonds given an Aaa or Baa rating by Moody's Investors Service respectively.
These corporate bonds often are used in macroeconomics as an alternative to the federal ten-year
Treasury Bill as an indicator of the interest rate.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="HighQualityMarketCorporateBond",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"yield_curve": "par", "provider": "fred"}),
],
)
async def hqm(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""High Quality Market Corporate Bond.
The HQM yield curve represents the high quality corporate bond market, i.e.,
corporate bonds rated AAA, AA, or A. The HQM curve contains two regression terms.
These terms are adjustment factors that blend AAA, AA, and A bonds into a single HQM yield curve
that is the market-weighted average (MWA) quality of high quality bonds.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="SpotRate",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"maturity": "10,20,30,50", "provider": "fred"}),
],
)
async def spot_rates(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Spot Rates.
The spot rates for any maturity is the yield on a bond that provides a single payment at that maturity.
This is a zero coupon bond.
Because each spot rate pertains to a single cashflow, it is the relevant interest rate
concept for discounting a pension liability at the same maturity.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(
model="CommercialPaper",
examples=[
APIEx(parameters={"provider": "fred"}),
APIEx(parameters={"maturity": "15d", "provider": "fred"}),
],
)
async def commercial_paper(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Commercial Paper.
Commercial paper (CP) consists of short-term, promissory notes issued primarily by corporations.
Maturities range up to 270 days but average about 30 days.
Many companies use CP to raise cash needed for current transactions,
and many find it to be a lower-cost alternative to bank loans.
"""
return await OBBject.from_query(Query(**locals()))
@router.command(model="BondPrices", examples=[APIEx(parameters={"provider": "tmx"})])
async def bond_prices(
cc: CommandContext,
provider_choices: ProviderChoices,
standard_params: StandardParams,
extra_params: ExtraParams,
) -> OBBject:
"""Corporate Bond Prices."""
return await OBBject.from_query(Query(**locals()))
|
