Find places by their rental market
findPlacesByMarketRank Canadian or US places by rental market facts (vacancy, rent, rent growth, permits, population). Read-only; signed-in only. Pass country (CA or US; places rank only within one country) and a preset (CA: tight-rental, fast-rent-growth, undersupplied, mli-select-headroom; US: low-rental-vacancy, car-light), filters ({ key, min, max } inclusive, or top/bottom percent), or both; optional region (province or state), sort, limit (default 20, max 50) and offset. An unknown key returns the filterable keys. Returns counts { places, matched, inPlan, excluded, unknown }, matched places with their values and access, and the places missing a filtered value. Report the unknown count: a missing value is not a match and not a fail. truncation.places.nextOffset is the next offset. Each matched place has access: in_plan (the user can screen its lots), available or not_sold (not in the user's plan). Say how many matches are in_plan. Only screen lots in in_plan places. To run a saved filter set, pass setId from listPlaceMarketSets with limit and offset only. unavailableFilters lists stored filters that were skipped; tell the user. Cite every figure with the sources lines (CMHC for CA, ACS for US). Tell the user each filter used, in plain words with units: each result filter has a text field. To find lots, call screenLots with the geoDivisionId of each in_plan place.
Turning a question into filters: pick the country from the place named (Ontario, Texas). Put a province or state in region. Map each condition to the closest key below. "Tight" or "low vacancy" is a max on a vacancy key; "growing" or "rising" is a min on a change key; "above" is min, "below" is max. Percent bounds are numbers: 5 means 5%. Money bounds are in the country's own dollars.
A relative question ("top quarter for rent growth", "lowest 10% vacancy in the province") is a percentile filter: top keeps the highest-valued share of places, bottom the lowest, as a percent (25 = 25%), instead of min and max. It ranks within the request's places, so give a region for "in the province". Each result filter states the cut value it resolved to in text.
Never invent a key. If no key below measures what was asked (for example a comparison to a provincial median), say so, name the nearest key, and use a numeric bound you state. Tell the user every filter you used, in plain words with units, before or with the result: each result filter has a text field for this.
On an UNKNOWN_KEY or CROSS_SCOPE error, read errorDetails and call again in the same turn with a key or region from it.
CA keys: population_density_per_sq_km: Density (people per km²). median_age: Median age (years). median_household_income: Median household income (CAD dollars). owner_occupied_pct: Owner-occupied (%). renter_occupied_pct: Renter-occupied (%). median_home_value: Median home value (CAD dollars). median_gross_rent: Median gross rent (CAD dollars). cmhc_rental_vacancy_rate: Purpose-built rental vacancy (%). cmhc_rental_availability_rate: Purpose-built rental availability (%). cmhc_avg_rent_studio: Avg rent, studio (purpose-built) (CAD dollars). cmhc_avg_rent_1br: Avg rent, 1BR (purpose-built) (CAD dollars). cmhc_avg_rent_2br: Avg rent, 2BR (purpose-built) (CAD dollars). cmhc_avg_rent_3br_plus: Avg rent, 3BR+ (purpose-built) (CAD dollars). cmhc_avg_rent_total: Avg rent, all units (purpose-built) (CAD dollars). cmhc_median_rent_total: Median rent, all units (purpose-built) (CAD dollars). cmhc_avg_rent_built_2000_plus: Avg rent, built 2000 or later (purpose-built) (CAD dollars). cmhc_avg_rent_change_pct: Avg rent change, same units (purpose-built) (%). signal_rent_cagr_5y_pct: Rent change, annualized over 5 years (%). signal_rental_vacancy_trend_3y_pp: Purpose-built rental vacancy change over 3 years (percentage points). signal_new_build_rent_premium_pct: Newer-building rent difference (built 2000 or later vs all units) (%). signal_rental_pipeline_pct: Rental units under construction as a share of purpose-built rental units (%). signal_rental_starts_momentum_pct: Rental starts, last 12 months vs the 12 months before (%). signal_mli_affordability_gap_pct: MLI Select rent difference as a share of average rent (%). signal_population_cagr_census_5y_pct: Population change per year, Census 2016 to 2021 (%). signal_household_income_cagr_census_5y_pct: Median household income change per year, Census 2016 to 2021 (2015 to 2020 incomes, nominal) (%).
US keys: population_density_per_sq_km: Density (people per km²). median_age: Median age (years). acs_households_no_vehicle_pct: Households with no vehicle (%). acs_households_one_vehicle_pct: Households with one vehicle (%). acs_households_two_plus_vehicles_pct: Households with two or more vehicles (%). acs_vehicles_per_household: Vehicles per household (vehicles per household). acs_commute_drove_alone_pct: Commute: drove alone (%). acs_commute_carpool_pct: Commute: carpool (%). acs_commute_transit_pct: Commute: public transit (%). acs_commute_walk_pct: Commute: walked (%). acs_commute_work_from_home_pct: Worked from home (%). median_household_income: Median household income (USD dollars). hud_ami_median_family_income: HUD area median family income (USD dollars). owner_occupied_pct: Owner-occupied (%). renter_occupied_pct: Renter-occupied (%). vacancy_rate: Vacancy rate (%). median_home_value: Median home value (USD dollars). median_gross_rent: Median gross rent (USD dollars). acs_rental_vacancy_rate: ACS rental vacancy rate (all rental units) (%). acs_median_gross_rent_built_2020_plus: ACS median gross rent, built 2020 or later (all rental units) (USD dollars). hud_fmr_efficiency: HUD FMR — efficiency (USD dollars). hud_fmr_one_bedroom: HUD FMR — 1BR (USD dollars). hud_fmr_two_bedroom: HUD FMR — 2BR (USD dollars). hud_fmr_three_bedroom: HUD FMR — 3BR (USD dollars). hud_fmr_four_bedroom: HUD FMR — 4BR (USD dollars). signal_rent_cagr_5y_pct: Rent change, annualized over 5 years (%). signal_rental_vacancy_trend_5y_pp: Rental vacancy change over 5 years (all rental units) (percentage points). signal_rent_premium_built_2020_plus_pct: Newer-building rent difference (built 2020 or later vs all units) (%). signal_multifamily_permits_pct: Units permitted in 5+ unit buildings, 12 months, as a share of renter-occupied units (%). signal_multifamily_permits_momentum_pct: Units permitted in 5+ unit buildings, last 12 months vs the 12 months before (%). signal_lihtc_rent_gap_pct: LIHTC 2-bedroom rent limit difference as a share of median gross rent (%). signal_population_cagr_acs_5y_pct: Population change per year, ACS 2015–2019 to 2020–2024 (%). signal_household_income_cagr_acs_5y_pct: Median household income change per year, ACS 2015–2019 to 2020–2024 (nominal) (%). signal_home_value_cagr_acs_5y_pct: Median home value change per year, ACS 2015–2019 to 2020–2024 (nominal) (%).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"context": "<context>"
},
"name": "findPlacesByMarket"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Defaults to the preset sort, else the first filter key | |
| limit | No | ||
| setId | No | Run one of your saved filter sets, by id from listPlaceMarketSets. Pass it with limit and offset only. | |
| offset | No | Matched places to skip. Copy truncation.places.nextOffset for the next page. | |
| preset | No | A preset id for the country; its filters apply first, then `filters` by key | |
| region | No | Province or state, as a code (AB) or a name (Alberta) | |
| context | Yes | A few words on why you are calling this tool, for the server developer's analytics. Describe people and things by role, such as "a customer". Do not quote the user or include names, emails, or other personal details. | |
| country | No | ISO country code. Places are filtered and ranked only within this country. | |
| filters | No | ||
| conversation_id | No | The conversation_id this server returned earlier in this conversation, unchanged, including after later user messages. Omit it if you have none. Recorded for the server developer's analytics. |