mortgage_indices

Mortgage Indices.

Examples

from openbb import obb
obb.fred.fixedincome.mortgage_indices(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.

index: str | None | list[str | None]
Default: primary
The specific index, or index group, to query. Default is the 'primary' group. Multiple items allowed.

Choices

• primary
• ltv_lte_80
• ltv_gt_80
• conforming_30y
• conforming_30y_na
• jumbo_30y
• fha_30y
• va_30y
• usda_30y
• conforming_15y
• ltv_lte80_fico_ge740
• ltv_lte80_fico_a720b739
• ltv_lte80_fico_a700b719
• ltv_lte80_fico_a680b699
• ltv_lte80_fico_lt680
• ltv_gt80_fico_ge740
• ltv_gt80_fico_a720b739
• ltv_gt80_fico_a700b719
• ltv_gt80_fico_a680b699
• ltv_gt80_fico_lt680

frequency: str | None

Description

Frequency aggregation to convert daily 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
Default: avg

Description

A key that indicates the aggregation method used for frequency aggregation.
This parameter has no affect if the frequency parameter is not set, default is 'avg'.
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.

---

Returns

results: FredMortgageIndices

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.

date: date | str
The date of the data.

conforming_30y: float | None
30-Year Fixed Rate Conforming.

conforming_30y_na: float | None
30-Year Fixed Rate Conforming Non-Adjusted.

jumbo_30y: float | None
30-Year Fixed Rate Jumbo.

fha_30y: float | None
30-Year Fixed Rate FHA.

va_30y: float | None
30-Year Fixed Rate Veterans Affairs.

usda_30y: float | None
30-Year Fixed Rate USDA.

conforming_15y: float | None
15-Year Fixed Rate Conforming.

ltv_lte80_fico_ge740: float | None
30-Year Fixed Rate Conforming LTV <= 80 FICO >= 740.

ltv_lte80_fico_a720b739: float | None
30-Year Fixed Rate Conforming LTV <= 80 FICO 720-739.

ltv_lte80_fico_a700b719: float | None
30-Year Fixed Rate Conforming LTV <= 80 FICO 700-719.

ltv_lte80_fico_a680b699: float | None
30-Year Fixed Rate Conforming LTV <= 80 FICO 680-699.

ltv_lte80_fico_lt680: float | None
30-Year Fixed Rate Conforming LTV <= 80 FICO < 680.

ltv_gt80_fico_ge740: float | None
30-Year Fixed Rate Conforming LTV > 80 FICO >= 740.

ltv_gt80_fico_a720b739: float | None
30-Year Fixed Rate Conforming LTV > 80 FICO 720-739.

ltv_gt80_fico_a700b719: float | None
30-Year Fixed Rate Conforming LTV > 80 FICO 700-719.

ltv_gt80_fico_a680b699: float | None
30-Year Fixed Rate Conforming LTV > 80 FICO 680-699.

ltv_gt80_fico_lt680: float | None
30-Year Fixed Rate Conforming LTV > 80 FICO < 680.