ameribor
Ameribor.
Examples
from openbb import obb
obb.fred.fixedincome.rate.ameribor(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 | list[str | None]
Default: all
Period of AMERIBOR rate. Multiple items allowed.
frequency: str | None
Description
Frequency aggregation to convert daily data to lower frequency.
a = Annual
q = Quarterly
m = Monthly
w = Weekly
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
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
log = Natural Log
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
Returns
results: FredAmeribor
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.
maturity: str
Maturity length of the item.
rate: float
Interest rate.
title: str | None
Title of the series.
date: date | str
The date of the data.
symbol: str | None
Symbol representing the entity requested in the data.
maturity: str
Maturity length of the item.
rate: float
Interest rate.
title: str | None
Title of the series.