GET
/
api
/
v1
/
personal-loan-rates
/
time-series
cURL
curl --request GET \
  --url https://ratesapi.nz/api/v1/personal-loan-rates/time-series
{
  "type": "PersonalLoanRatesTimeSeries",
  "timeSeries": {},
  "availableDates": [
    "<string>"
  ],
  "termsOfUse": "<string>",
  "timestamp": "2025-03-04T02:30:00.000Z"
}
This endpoint provides historical time series data for personal loan 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 secured and unsecured personal loans
  • Fixed and variable rate options
  • Minimum and maximum loan amounts
  • Available loan terms
  • Any special conditions or promotions

​
Use Cases

  • Rate Trend Analysis: Monitor how personal loan rates fluctuate over time
  • Competitive Intelligence: Compare rate changes across different lenders
  • Consumer Education: Provide historical context for current personal loan offerings
  • Financial Planning Tools: Incorporate historical rate data into loan calculators and planning applications
  • Research and Reporting: Support academic or market research with reliable historical data

​
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"

Response

Retrieve personal loan rates time series data

​
type
enum<string>
required
Available options:
PersonalLoanRatesTimeSeries
​
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"