Get rent metrics for properties

Get pre-aggregated rent metrics (avg/min/max/median) for one or more properties.
Returns compact statistical summaries -- much more token-efficient than fetching raw listings.

Use when you have individual property IDs (not a comp set).

Each response includes for every grouping level:
- askingRent, effectiveRent, askingRentPSF, effectiveRentPSF (avg/min/max/median)
- deposit, squareFootage (avg/min/max/median)
- averageListingDays, recordsQuantity, totalUnits, unitsAvailable

Inputs

Parameter	Required	Type	Details
date_from	No	anyOf	Start date in YYYY-MM-DD format (default: 30 days ago) Default: null
date_to	No	anyOf	End date in YYYY-MM-DD format (default: today) Default: null
grouping	No	string	Level of detail for metrics breakdown: - "PROPERTY": One aggregate row per property (simplest) - "BEDROOM": Break down by bedroom count per property (default, recommended) - "UNIT_MIX": Break down by bedroom/bathroom combination per property - "FLOOR_PLAN": Break down by floor plan per property Default: "BEDROOM" Allowed: ["PROPERTY","BEDROOM","UNIT_MIX","FLOOR_PLAN"]
lease_term	No	anyOf	Optional filter for lease term in months (e.g., 12 for 12-month leases) Default: null
property_ids	Yes	array	List of property IDs (up to 150)
unit_condition	No	anyOf	Optional filter for renovation status: - "RENO": Only renovated units - "NON_RENO": Only non-renovated units - None: All units (default) Default: null

Annotations

{
  "title": "Get rent metrics for properties",
  "readOnlyHint": true,
  "destructiveHint": false,
  "openWorldHint": false
}

Input schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "property_ids": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "description": "List of property IDs (up to 150)"
    },
    "date_from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Start date in YYYY-MM-DD format (default: 30 days ago)"
    },
    "date_to": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "End date in YYYY-MM-DD format (default: today)"
    },
    "grouping": {
      "default": "BEDROOM",
      "enum": [
        "PROPERTY",
        "BEDROOM",
        "UNIT_MIX",
        "FLOOR_PLAN"
      ],
      "type": "string",
      "description": "Level of detail for metrics breakdown:\n- \"PROPERTY\": One aggregate row per property (simplest)\n- \"BEDROOM\": Break down by bedroom count per property (default, recommended)\n- \"UNIT_MIX\": Break down by bedroom/bathroom combination per property\n- \"FLOOR_PLAN\": Break down by floor plan per property"
    },
    "unit_condition": {
      "anyOf": [
        {
          "enum": [
            "RENO",
            "NON_RENO"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional filter for renovation status:\n- \"RENO\": Only renovated units\n- \"NON_RENO\": Only non-renovated units\n- None: All units (default)"
    },
    "lease_term": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Optional filter for lease term in months (e.g., 12 for 12-month leases)"
    }
  },
  "required": [
    "property_ids"
  ]
}