Preview tool · Property context

New Zealand rent statistics

Preview: Compare New Zealand residential rent statistics by area, dwelling type, bedrooms and pooled period.

Start building free Connect your client

Published tool ID

nz_market_rent

Preview: Compare New Zealand residential rent statistics by area, dwelling type, bedrooms and pooled period.

ServerNew Zealand

Information categoryResidential rental statistics

Credit behavior1 credit

AccessWorkspace permissions

Inputs and outputs

Published input schema

Use the discovered runtime schema for the workspace you are connected to.

Public catalog

nz_market_rent input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "area_level": {
      "type": "string",
      "enum": [
        "region",
        "territorial_authority",
        "sa2"
      ]
    },
    "place": {
      "description": "Exact place label or supported region alias; provide exactly one of place or area_code.",
      "type": "string",
      "minLength": 2,
      "maxLength": 100
    },
    "area_code": {
      "description": "Official code for the selected area level; provide exactly one of place or area_code.",
      "type": "string",
      "pattern": "^\\d{1,12}$"
    },
    "dwelling_type": {
      "default": "all",
      "type": "string",
      "enum": [
        "house",
        "apartment",
        "flat",
        "boarding_house",
        "room",
        "all"
      ]
    },
    "bedrooms": {
      "default": "all",
      "type": "string",
      "enum": [
        "1",
        "2",
        "3",
        "4",
        "5_plus",
        "unknown",
        "all"
      ]
    },
    "period_ending": {
      "description": "Pooled period end (YYYY-MM); defaults to the latest available month, two months before the current month.",
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
    },
    "num_months": {
      "default": 6,
      "type": "integer",
      "minimum": 1,
      "maximum": 24
    },
    "compare_to": {
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$",
      "description": "Pooled period end (YYYY-MM); defaults to the latest available month, two months before the current month."
    }
  },
  "required": [
    "area_level",
    "dwelling_type",
    "bedrooms",
    "num_months"
  ],
  "additionalProperties": false
}

Published output shape

Tool results return structured data or a stable error object.

Shared Aroai tool output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "summary": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {}
        },
        "executionId": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "creditsCharged": {
          "type": "number",
          "minimum": 0
        }
      },
      "required": [
        "summary",
        "data",
        "creditsCharged"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "retryable": {
              "type": "boolean"
            }
          },
          "required": [
            "code",
            "message",
            "retryable"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "error"
      ],
      "additionalProperties": false
    }
  ]
}

Source and usage notes

Understand the result boundary

Returns area-level rental statistics, not advertised rents or a property valuation.
Area labels and boundaries can differ. Confirm the matched area before comparing results.
Data is lagged and pooled across the selected period.

Explore AU/NZ toolkits

Use this capability

Build on your next business question.

Explore related tools or connect your AI client to get started.

Explore tools Client setup

Local intelligence. Ready to build.

Put your AI to work.

Create a free workspace and bring local business context into your AI tools.

Start building free Explore tools