jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ea9cedbb2e77b633a43578c69b4e89bfa5c5f7cb
OpenBB/website/content/platform/data_models/USYieldCurve.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774) 
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

1.4 KiB
Vendored
Raw Blame History

title, description
title description
US Yield Curve OpenBB Platform Data Model

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Implementation details

Class names

Model name Parameters class Data class
USYieldCurve USYieldCurveQueryParams USYieldCurveData

Import Statement

from openbb_core.provider.standard_models.us_yield_curve import (
USYieldCurveData,
USYieldCurveQueryParams,
)

Parameters

Name Type Description Default Optional
date date A specific date to get data for. Defaults to the most recent FRED entry. None True
inflation_adjusted bool Get inflation adjusted rates. False True
provider Literal['fred'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. fred True

Data

Name Type Description
maturity float Maturity of the treasury rate in years.
rate float Associated rate given in decimal form (0.05 is 5%)