Quickstart
Get New Zealand mortgage rates as JSON with one curl request. Filter by term, get the rates of one bank, and get earlier rates. No API key.
Do these steps to get data from Rates API. An API key is not necessary.
1. Get the Newest Mortgage Rates
curl https://www.ratesapi.nz/api/v1/mortgage-ratesThe response contains a list of institutions. Each institution has products, and each product has rates. Keep the id of an institution for the steps that follow.
2. Get the Rates for One Term
curl "https://www.ratesapi.nz/api/v1/mortgage-rates?termInMonths=12"The termInMonths parameter gives only the fixed rates for one term. The data contains terms of 6, 12, 18, 24, 36, 48, and 60 months. The response does not contain variable floating rates.
3. Get the Rates of One Institution
curl https://www.ratesapi.nz/api/v1/mortgage-rates/institution:anzUse this endpoint for a page about one lender. You can also use it to update the data of one lender only.
4. Get One Snapshot
curl "https://www.ratesapi.nz/api/v1/mortgage-rates/time-series?date=2026-04-30&institutionId=institution:anz&termInMonths=12"The date parameter gives the snapshot of that date. If that date has no snapshot, the API returns HTTP 404.
5. Get the Snapshots in a Range
curl "https://www.ratesapi.nz/api/v1/mortgage-rates/time-series?startDate=2026-04-01&endDate=2026-04-30&institutionId=institution:anz"Send startDate and endDate together. The range contains the two dates. Do not send date with a range.
The API keeps a snapshot only when the data changes. Because of this, some dates in a range have no snapshot. The availableDates field shows the dates that have a snapshot.
6. Examine the API in the Browser
Open /openapi to send requests from the Scalar API client. To get the OpenAPI document, use /openapi/json.
7. Connect an AI Agent
If your agent can use the Model Context Protocol (MCP), send requests to the MCP endpoint:
POST https://www.ratesapi.nz/api/v1/mcpTo give an assistant a list of the documentation pages, use /llms.txt. To get the request and response schemas, use /openapi/json. Some AI frameworks can make tools from this OpenAPI contract.
Next Steps
- Read AI Integration for MCP, OpenAPI, and
llms.txt. - Read Core Concepts for IDs, dates, errors, and data freshness.
- Use the OpenAPI reference to find all parameters and response fields of each endpoint.
- To run or deploy the project, read Open Source.
Last updated on
API Reference
The base URL, endpoints, filters, errors, and time-series rules for New Zealand mortgage, personal loan, car loan, and credit card rates.
AI Integration
Connect AI agents to New Zealand mortgage and loan rates. Use the free MCP endpoint, the OpenAPI JSON for tool generation, and llms.txt.