Get Comp Set Details

Raw property data for the subject/base property: amenities, unit listings, reviews.

WHEN TO CALL: For amenities — pool, gym, pet policy, what the property offers —
use data_level="amenities". Only go to 'detailed'/'full' when the user asks for
individual unit-by-unit listing prices or resident review scores.

COST WARNING: 'detailed' and 'full' levels return 50K-200K+ tokens.
'amenities' carries no listings and no rest-of-the-property-record, and
measured under 2K characters per property.

Inputs

Parameter	Required	Type	Details
comp_set_id	Yes	string	The unique identifier of the comp set to retrieve
data_level	No	string	Level of detail to retrieve, cheapest first. Options: - "minimal": Basic comp set info only (id, name, propertyId, compsTotal) (default) - "amenities": The BASE property's amenity lists and nothing else — {propertyId, name, amenities, unitAmenities}. Use this for any amenity question. - "detailed": Adds rent summaries, concessions, listings for BASE property. WARNING: Very large response. Only use when individual unit listings are needed. - "full": Adds historical data, reviews, quality scores for BASE property. WARNING: Very large response. Default: "minimal" Allowed: ["minimal","amenities","detailed","full"]
date_from	No	anyOf	Start date for time-based data in YYYY-MM-DD format (default: 90 days ago) Default: null
date_to	No	anyOf	End date for time-based data in YYYY-MM-DD format (default: today) Default: null
unit_grouping	No	string	How to group unit rent data in detailed/full levels. Options: - "BY_BEDROOM": Group by bedroom count - studio, 1BR, 2BR, etc. (default) - "BY_UNIT": Individual unit data - "BY_UNIT_MIX": Group by bedroom/bathroom combination - "BY_PROPERTY": Aggregate for entire property - "BY_FLOOR_PLAN": Group by floor plan name Default: "BY_PROPERTY" Allowed: ["BY_BEDROOM","BY_UNIT","BY_UNIT_MIX","BY_PROPERTY","BY_FLOOR_PLAN"]

Annotations

{
  "title": "Get Comp Set Details",
  "readOnlyHint": true,
  "destructiveHint": false,
  "openWorldHint": false
}

Input schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "comp_set_id": {
      "type": "string",
      "description": "The unique identifier of the comp set to retrieve"
    },
    "data_level": {
      "default": "minimal",
      "enum": [
        "minimal",
        "amenities",
        "detailed",
        "full"
      ],
      "type": "string",
      "description": "Level of detail to retrieve, cheapest first. Options:\n- \"minimal\": Basic comp set info only (id, name, propertyId, compsTotal) (default)\n- \"amenities\": The BASE property's amenity lists and nothing else —\n  {propertyId, name, amenities, unitAmenities}. Use this for any\n  amenity question.\n- \"detailed\": Adds rent summaries, concessions, listings for BASE property.\n  WARNING: Very large response. Only use when individual unit listings are needed.\n- \"full\": Adds historical data, reviews, quality scores for BASE property.\n  WARNING: Very large response."
    },
    "date_from": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Start date for time-based data in YYYY-MM-DD format (default: 90 days ago)"
    },
    "date_to": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "End date for time-based data in YYYY-MM-DD format (default: today)"
    },
    "unit_grouping": {
      "default": "BY_PROPERTY",
      "enum": [
        "BY_BEDROOM",
        "BY_UNIT",
        "BY_UNIT_MIX",
        "BY_PROPERTY",
        "BY_FLOOR_PLAN"
      ],
      "type": "string",
      "description": "How to group unit rent data in detailed/full levels. Options:\n- \"BY_BEDROOM\": Group by bedroom count - studio, 1BR, 2BR, etc. (default)\n- \"BY_UNIT\": Individual unit data\n- \"BY_UNIT_MIX\": Group by bedroom/bathroom combination\n- \"BY_PROPERTY\": Aggregate for entire property\n- \"BY_FLOOR_PLAN\": Group by floor plan name"
    }
  },
  "required": [
    "comp_set_id"
  ]
}