diff options
author | Henrique Joaquim <henriquecjoaquim@gmail.com> | 2024-06-07 14:47:39 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-07 14:47:39 +0100 |
commit | c6a49ef44529df522845d7cf75f438b12ec4ee72 (patch) | |
tree | 99ed8fa376794eb4775eef016be41810a393b74a /openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py | |
parent | e15aaa5c2daa0a655aead4d9580c4a718007e37f (diff) | |
parent | aa7bccc4eccc67764ecd3a62f1e7c5f8323cbac0 (diff) |
Merge branch 'develop' into feature/generate-cli-settingsfeature/generate-cli-settings
Diffstat (limited to 'openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py')
-rw-r--r-- | openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py b/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py index 0e232cb1cdb..fb346dd3cc3 100644 --- a/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py +++ b/openbb_platform/extensions/fixedincome/openbb_fixedincome/fixedincome_router.py @@ -44,3 +44,40 @@ async def sofr( 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())) |