tips_yields
Get current Treasury inflation-protected securities yields.
Examples
from openbb import obb
obb.fred.fixedincome.government.tips_yields(provider='fred')
Parameters
- standard
- fred
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
maturity: str | None
The maturity of the security in years - 5, 10, 20, 30 - defaults to all. Note that the maturity is the tenor of the security, not the time to maturity.
Choices
- 5
- 10
- 20
- 30
frequency: str | None
Description
Frequency aggregation to convert high frequency data to lower frequency.
None = No change
a = Annual
q = Quarterly
m = Monthly
w = Weekly
d = Daily
wef = Weekly, Ending Friday
weth = Weekly, Ending Thursday
wew = Weekly, Ending Wednesday
wetu = Weekly, Ending Tuesday
wem = Weekly, Ending Monday
wesu = Weekly, Ending Sunday
wesa = Weekly, Ending Saturday
bwew = Biweekly, Ending Wednesday
bwem = Biweekly, Ending Monday
Choices
- a
- q
- m
- w
- d
- wef
- weth
- wew
- wetu
- wem
- wesu
- wesa
- bwew
- bwem
aggregation_method: str | None
Description
A key that indicates the aggregation method used for frequency aggregation.
avg = Average
sum = Sum
eop = End of Period
Choices
- avg
- sum
- eop
transform: str | None
Description
Transformation type
None = No transformation
chg = Change
ch1 = Change from Year Ago
pch = Percent Change
pc1 = Percent Change from Year Ago
pca = Compounded Annual Rate of Change
cch = Continuously Compounded Rate of Change
cca = Continuously Compounded Annual Rate of Change
Choices
- chg
- ch1
- pch
- pc1
- pca
- cch
- cca
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
Returns
results: FredTipsYields
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- fred
date: date | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
due: date | None
The due date (maturation date) of the security.
name: str | None
The name of the security.
value: float | None
The yield value.
date: date | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
due: date | None
The due date (maturation date) of the security.
name: str | None
The name of the security.
value: float | None
The yield value.