Get Property Location Taxonomy
get_property_location_taxonomyFull Description
This tool provides the Trade Me location hierarchy for use in property for sale searches.
When you call it, you will receive the three-tier location taxonomy from Trade Me, enabling you to discover valid location IDs for use in searching for properties for sale using the search_residential_properties tool. The location hierarchy is:
- Region (top level) → District (middle) → Suburb (most granular)
Each location includes: • A Unique numeric ID (for use in the search_residential_properties tool, these numeric ID's are never shown to users) • A Human-readable location name • It's child locations (regions contain districts, districts contain suburbs) • Any adjacent suburbs (for suburb-level locations)
Use this tool when you need to: • Find district or suburb IDs for use in searches for properties for sale (NOT regions - region IDs are already provided in search_residential_properties tool parameters) • Resolve ambiguous location names (e.g., "Te Atatū" has Peninsula and South suburbs) • Discover all districts within a region • Find all suburbs within a district • Explore nearby/adjacent suburbs • Support cross-region searches using multiple suburb IDs
DO NOT use this tool when: • Looking up region IDs - these are already documented in the region_id parameter description • The user is speaking at region level only (region IDs are pre-provided) • A simple clarifying question can resolve the user's intent without needing IDs • The user has not yet chosen a specific area • To search for rental properties - this is important!
USER-FACING LANGUAGE (IMPORTANT): • NEVER expose technical terms like "suburb_id", "district_id", "region_id" when asking users for clarification • ALWAYS Use natural language: "Which area did you mean: Te Atatū Peninsula or Te Atatū South?" • NOT: "I need the suburb_id for Te Atatū. Here are the options..." • DO NOT show raw taxonomy or long lists unless the user asks for them • When listing options, provide short, summarised sets and offer to expand • When a clarifying question is asked (e.g., for ambiguous names), present the options and immediately suggest the next action: "Which area did you mean: Te Atatū Peninsula or Te Atatū South? Selecting one will allow me to start your property search."
CROSS-REGION AND CROSS-DISTRICT SEARCHES: When searches span multiple regions OR multiple districts, CALL THIS TOOL WITHOUT region_id:
Call with region_id=None when: • Multiple regions: "properties in Auckland and Wellington" • Multiple districts across regions: "beach suburbs in North Island" • Exploratory/broad searches: "coastal towns", "near universities", "ski towns" • Any search needing suburb IDs from different districts or regions
Why omit region_id: • Returns COMPLETE nationwide taxonomy (all regions → all districts → all suburbs) • Enables extraction of suburb IDs from anywhere in New Zealand • suburb_id parameter accepts lists spanning multiple districts AND regions
Example workflow: User: "Beach properties across North Island" 1. Call get_property_location_taxonomy(region_id=None) ← Get everything 2. Search taxonomy for coastal suburbs in Auckland, Bay of Plenty, Gisborne regions 3. Extract suburb IDs from multiple regions: [268, 412, 589, 701, 823, ...] 4. Call search_residential_properties(suburb_id=[268, 412, 589, 701, 823, ...])
Single region vs cross-region: • Single region: CAN filter with region_id=1 (gets only Auckland districts/suburbs) • Cross-region/district: MUST use region_id=None (gets all locations nationwide)
Handling unknown/misspelled locations: • Suggest possible matches or nearby well-known areas • If unclear, ask the user what area it is near before calling the tool
Decision flow (when to call tool vs when to ask for clarification): 1. Region name (e.g., "Auckland") → DO NOT call tool (region IDs are pre-provided in search parameters) 2. Unambiguous district/suburb name → Call tool to get numeric ID (search requires IDs, not names) 3. Ambiguous name (e.g., "Te Atatū") → Call tool first, detect multiple matches, then ask user which one 4. Colloquial/landmark name → Ask for clarification → call tool to get ID 5. District where suburbs are needed → Call tool to list suburbs 6. "Nearby suburbs" → Call tool (adjacency information) 7. Multiple areas across regions → Call tool once to get all suburb IDs → combine into comma-separated string 8. Misspellings/unknown → Suggest matches → call tool to confirm
KEY INSIGHT: The search tool requires numeric IDs, not location names. The *immediate and only purpose* of calling this tool is to efficiently and conversationally retrieve the IDs needed to perform the property search and then generate market insights for the user.
ALWAYS focus on natural, friendly communication and avoid exposing internal identifiers.
Parameters
region_idintegerOptional region ID to filter results to a specific region. OMIT this parameter (call with region_id=None) when you need to explore suburbs across multiple regions OR multiple districts within different regions. When omitted, returns the complete nationwide taxonomy (all regions, districts, and suburbs), enabling you to extract suburb IDs from any location for use in cross-region or cross-district searches.
null