API ReferenceEndpointsMortgage Rates

Get Mortgage Rates by Institution ID

Retrieve current mortgage rates for one financial institution.

Endpoint

Field	Value
Method	`GET`
Path	`/api/v1/mortgage-rates/{institutionId}`
Operation ID	`getMortgageRatesByInstitution`

Parameter	Description
`institutionId`	institution identifier, e.g. institution:anz
`termInMonths`	optional mortgage term filter

Status	Description
`200`	Retrieve mortgage rates for the institution
`404`	Institution not found
`500`	Server error

Retrieve mortgage rates for a specific institution.

List Mortgage Rates

Retrieve current mortgage rates from New Zealand financial institutions.

Mortgage Rates Time Series

Retrieve historical time series data for mortgage rates from New Zealand financial institutions.