GET
/
api
/
v1
/
mortgage-rates
/
time-series
cURL
curl --request GET \
  --url https://ratesapi.nz/api/v1/mortgage-rates/time-series
{
  "type": "MortgageRatesTimeSeries",
  "timeSeries": {},
  "availableDates": [
    "<string>"
  ],
  "termsOfUse": "<string>",
  "timestamp": "2025-03-04T02:30:00.000Z"
}
This endpoint provides historical time series data for mortgage rates, allowing you to analyze trends and changes over time. The data is stored in Cloudflare D1 database, enabling efficient querying of historical datasets.

​
Response Data

The response includes:
  • Timestamp for each data point
  • Institution name and ID
  • Interest rates for different term periods (6 months, 1 year, 2 years, etc.)
  • Floating/variable rates
  • Special rates and promotional offers
  • Loan-to-value ratio requirements

​
Use Cases

  • Historical Analysis: Track how mortgage rates have changed over time to identify trends and patterns
  • Comparative Studies: Compare rate changes across different institutions to identify competitive offerings
  • Economic Research: Correlate interest rate changes with wider economic indicators
  • Predictive Modeling: Develop forecasting models based on historical rate movements
  • Visualization Tools: Create interactive charts and graphs showing rate trends over time

​
Notes on Data Storage

The time series data is stored in Cloudflare D1, a serverless SQL database built on SQLite. This allows for:
  • Efficient querying of historical datasets
  • Fast retrieval of large time series datasets
  • Reliable data persistence and backup
  • Scalable performance for growing historical datasets

Query Parameters

​
date
string

Date in YYYY-MM-DD format for historical data

Example:

"2025-03-01"

​
startDate
string

Start date in YYYY-MM-DD format for time series range

Example:

"2025-01-01"

​
endDate
string

End date in YYYY-MM-DD format for time series range

Example:

"2025-03-01"

​
institutionId
string

Optional institution ID to filter time series data

Example:

"institution:anz"

​
termInMonths
string

Optional mortgage term in months to filter by

Examples:

"6"

"12"

"24"

"36"

Response

Retrieve mortgage rates time series data

​
type
enum<string>
required
Available options:
MortgageRatesTimeSeries
​
timeSeries
object
required

Time series data keyed by date in YYYY-MM-DD format

​
availableDates
string[]
required

List of all available dates in YYYY-MM-DD format

​
termsOfUse
string
required
​
timestamp
string
required

Current server timestamp

Example:

"2025-03-04T02:30:00.000Z"