Fred Overnight Bank Funding Rate
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FredOvernightBankFundingRate | FredOvernightBankFundingRateQueryParams | FredOvernightBankFundingRateData |
Import Statement
from openbb_core.provider.standard_models. import (
FredOvernightBankFundingRateData,
FredOvernightBankFundingRateQueryParams,
)
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.
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
Choices
- a
- q
- m
- w
- 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
log = Natural Log
Choices
- chg
- ch1
- pch
- pc1
- pca
- cch
- cca
- log
use_cache: bool | None
Default: True
When True, the request is served from, and written to, the FRED response cache.
Data
- standard
- fred
date: date | str
The date of the data.
rate: float
Overnight Bank Funding Rate.
percentile_1: float | None
1st percentile of the distribution.
percentile_25: float | None
25th percentile of the distribution.
percentile_75: float | None
75th percentile of the distribution.
percentile_99: float | None
99th percentile of the distribution.
volume: float | None
The trading volume.The notional volume of transactions (Billions of $).
date: date | str
The date of the data.
rate: float
Overnight Bank Funding Rate.
percentile_1: float | None
1st percentile of the distribution.
percentile_25: float | None
25th percentile of the distribution.
percentile_75: float | None
75th percentile of the distribution.
percentile_99: float | None
99th percentile of the distribution.
volume: float | None
The trading volume.The notional volume of transactions (Billions of $).