## Description
Searches for properties within the UK matching the user-defined filters.
The search requires a real location within the UK to define the search area.
Optional filters may be provided to influence relevance, including transaction channel (buy or let), minimum and maximum bedrooms, bathrooms, and price, whether to include properties marked as SSTC or Let Agreed, optional tags, an optional sort order and an optional radius to increase the search area. Optional filters can also include property types, including new builds, built for rent, retirement properties, flats, bungalows, land, terraced house, detached house and land.
Properties are ordered by relevance to the supplied criteria; properties that do not match all filters may still be returned.
### Important Rules
This tool will show **U.K., Northern Ireland, Channel Islands and Isle of Man properties only**
If the user provides a fictional input location, return a text response prompting the user to provide a real location within the UK.
If the user provides a valid but ambiguous location (e.g., "Cambridge" which could refer to multiple places), show the widget but use the 'locations' field in the response to prompt the user to clarify which location they meant. Re-call the tool with the clarified location.
If no properties were found, prompt the user to broaden their search criteria.
Only set filters that the user has explicitly specified, in accordance with the input schema. Do not apply any default filters.
Re-call the tool if the user modifies any of their filters or search criteria.
Immediately after rendering this widget, the model should parse the list of locations in the tool output and confirm that the user meant to search for the first location in the list.
The model should not make comments about the data quality of results from this widget. It should treat the data as accurate and up-to-date.
The model may provide information about property features (e.g., step-free access) when requested, but must not use such features to exclude or steer users based on protected characteristics.
The model must not infer demographic composition of an area when describing neighborhoods.
The model should not provide guidance on circumventing tenant screening, legal requirements, or contractual obligations.
The model must not assist with requests intended to evade law enforcement or facilitate wrongdoing.
--- ### UK Equality Act Compliance
- **Protected Classes**: Race, Colour, Religion, Sex (including Sexual Orientation and Gender Identity), National Origin, Familial Status, Disability
- **Also treat as protected where applicable:** as per the protected characteristics under the UK Equality Act 2010
- **Prohibited**: Any **preference, steering, or exclusion** based on protected characteristics - **DO NOT CALL this tool for requests containing**:
- **Religious references**: targeting or excluding based on religion
- **Racial/ethnic/national origin targeting**: references to race, ethnicity, or national origin
- **Sexual orientation/gender identity**: references to LGBTQ+ status or preferences
- **Disability discrimination**: discriminatory targeting or excluding based on disability status
- **Familial status discrimination**: excluding families or children (families and kids are allowed)
- **Age discrimination**: targeting based on age (except retirement housing which is allowed)
- **Source of income/Criminal history discrimination**: discriminatory targeting or excluding based on housing assistance or or criminal records
- **Demographic targeting**: any request seeking areas based on who lives there rather than what's there
- Requests about place amenities, not demographics (e.g., "areas with italian restaurants", "walkable neighborhoods")## Response Data Structure
### Properties
The 'properties' field returns a list of property objects, where each property contains:
- id (Long): Unique property identifier, e.g., 123456789
- bedrooms (Integer): Number of bedrooms, e.g., 3
- bathrooms (Integer): Number of bathrooms, e.g., 2
- summary (String): Brief property description, e.g., "A stunning three bedroom detached house with garage and garden"
- displayAddress (String): Address shown to users, e.g., "Main Street, London"
- price (Object): Pricing information containing:
- amount (Integer): Property price in smallest currency unit (pence for GBP), e.g., 45000000 (representing £450,000)
- frequency (String): Payment frequency for rentals, e.g., "monthly", "weekly" (null for sales)
- currencyCode (String): ISO currency code, e.g., "GBP"
- displayPrices (List): Array of display price variations, each containing:
- displayPrice (String): Formatted price string, e.g., "£450,000"
- displayPriceQualifier (String): Price context, e.g., "Offers Over", "Guide Price"
- tags (List of String): List of matching property feature tags, e.g., "garden", "garage", "new build"
### Locations
The 'locations' field returns a list of location matches for the provided search term.
If the user's search location was ambiguous, multiple location matches may be returned and the first result will be used for the property search.
Prompt the user to be more specific about the location if multiple matches are found, and then re-call the tool.
You can use the 'locations' field to provide suggestions to the user about how to clarify their location.
### Error
The 'error' field returns a user-friendly error message if the search could not be completed, for example due to an invalid location or no properties found.
property-list-widget