Show Property List
property-list-widgetFull Description
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.
Parameters (1 required, 20 optional)
locationstringMandatory location for the area of the search within the UK - required when performing a property SEARCH. This should be a real UK geographic area used to search for multiple listings. Valid inputs include:postcode or outcode; town, city, or region; coastal area or descriptive geography; major station or commuting hub. Location behaviour rules: - If the user provides a UK location, use it directly. - If the user expresses a lifestyle or geographic intent (e.g. “by the sea”, “near London”, “commutable”), infer one or more sensible UK search areas that satisfy the intent. - If the user clearly wants to search but gives no geographic signal at all, ask a clarifying question instead of inventing a location. - Never fabricate fictional places. This field should NOT be populated unless the tool is being used for a multi-property search.
channelstringOptional transaction type for the search. Must be either "BUY" or "RENT". Defaults to "BUY" if not specified.
dontShowarrayOptional list of features the property should not have. Each value must be one of: NEW_HOME,RETIREMENT,SHARED_OWNERSHIP,BUYING_SCHEMES,AFFORDABLE_BUYING_SCHEMES,AUCTION,BUSINESS_FOR_SALE,HOUSE_SHARE,STUDENT,GARDEN,PARKING,PRIVATE_POOL,COMMUNAL_POOL,GOLF,AT_GOLF_COURSE,NEAR_GOLF_COURSE,BEACHFRONT,NEAR_BEACH,SEA_VIEW
furnishTypesarrayOptional list of furnish types for rental properties. Only applicable when channel is "RENT". Must be one of FURNISHED,PART_FURNISHED,UNFURNISHED.
hasUnrelatedContentbooleanBoolean indicating if the user prompt contains **only** requests unrelated to property search. If the user mentions details helpful for the agent to set property search filters, set to false.
includeLetAgreedbooleanOptional boolean to include properties marked as Let Agreed. Defaults to false.
includeSSTCbooleanOptional boolean to include properties marked as Sold Subject to Contract (SSTC). Defaults to false.
isComparisonbooleanOptional boolean indicating if the user asked for property comparison. It must be true if the user states anything about comparing properties, and false otherwise.
letTypestringOptional let type for rental properties. Only applicable when channel is "RENT". Must be one of: "LONG", "SHORT", "STUDENT".
LONGSHORTSTUDENTmaxBathroomsintegerOptional maximum number of bathrooms. Accepts values from 1 to 5.
maxBedroomsintegerOptional maximum number of bedrooms. Accepts values from 0 (studio) to 10.
maxPriceintegerOptional maximum price in GBP (£). Accepts values from £0 to £50,000,000.
minBathroomsintegerOptional minimum number of bathrooms. Accepts values from 1 to 5.
minBedroomsintegerOptional minimum number of bedrooms. Accepts values from 0 (studio) to 10.
minPriceintegerOptional minimum price in GBP (£). Accepts values from £0 to £50,000,000.
mustHavearrayOptional list of features the property must have. Each value must be one of: NEW_HOME,RETIREMENT,SHARED_OWNERSHIP,BUYING_SCHEMES,AFFORDABLE_BUYING_SCHEMES,AUCTION,BUSINESS_FOR_SALE,HOUSE_SHARE,STUDENT,GARDEN,PARKING,PRIVATE_POOL,COMMUNAL_POOL,GOLF,AT_GOLF_COURSE,NEAR_GOLF_COURSE,BEACHFRONT,NEAR_BEACH,SEA_VIEW
propertyTypesarrayOptional list of property types. Each value must be one of: HOUSE, DETACHED, SEMI_DETACHED, TERRACED, FLAT, BUNGALOW, LAND, PARK_HOME, MOBILE_HOME, STUDENT_HALL, SERVICED_OFFICE, BUSINESS_PARK, OFFICE, WORKSHOP, POST_OFFICE, HAIRDRESSER, GARAGE, CONVENIENCE_STORE, SHOP, RETAIL_HIGH_STREET, RETAIL_OUT_OF_TOWN, RETAIL_SHOPPING_CENTRE, RETAIL_RETAIL_PARK, RETAIL_POP_UP, LEISURE_FACILITY, PUB, RESTAURANT, CAFE, HOTEL, TAKEAWAY, BAR_NIGHTCLUB, GUEST_HOUSE, HOSPITALITY, WAREHOUSE, SHOWROOM, STORAGE, LIGHT_INDUSTRIAL, HEAVY_INDUSTRIAL, DISTRIBUTION_WAREHOUSE, TRADE_COUNTER, FACTORY, INDUSTRIAL_PARK, RESIDENTIAL_DEVELOPMENT, INDUSTRIAL_DEVELOPMENT, FARM, MIXED_USE, HEALTHCARE_FACILITY, CHILDCARE_FACILITY, PLACE_OF_WORSHIP, PETROL_STATION, OTHER
radiusnumberOptional search radius, in miles, defining the distance from the specified location. Must be one of the following: 0.25,0.5,1,3,5,10,15,20,30,40. Round to the nearest allowed value if an invalid radius is provided.
sortTypestringSort order (string id). Allowed values: 1=PRICE_ASC, 2=PRICE_DESC, 4=DISTANCE_ASC, 6=ADDED_DATE_DESC, 10=ADDED_DATE_ASC, 13=RELEVANCE_DESC, 14=SIZE_ASC, 15=SIZE_DESC, 18=SCORE_DESC. If omitted, the search API defaults to 2 (price, descending) when the channel is BUY and 6 (newest first) when the channel is RENT.
12461013141518tagsarrayOptional property features or classifications. Must be one of the following: air conditioning,annexe,arched windows,attic,auction,balcony,barbeque,area,barn,barn conversion,basement,bathtub,bay windows,bifold doors,bike storage,bills included,block of apartments,brick built,built for rent,bungalow,canalside,caravan,carpeted flooring,carport,cash buyer,cctv system,cellar,central location,chain free,character,children play area,cinema room,city centre,cloakroom,close to beach,close to church,close to golf course,close to park,close to schools,close to shops,close to station,close to university,close to woodland,coach house,coastal,communal garden,concierge,conservatory,contemporary style,converted property,corner plot,cottage,countryside views,courtyard,cul de sac,detached,detached bungalow,detached garage,development potential,dining room,dishwasher,dormer,dormer windows,double garage,double glazed windows,downstairs bedroom,dressing room,driveway,duplex,eco friendly,edwardian,electric heating,end of terrace,ensuite,equestrian,exposed beams,exposed brick,farm,farmhouse,fenced,fireplace,first floor,freehold,games room,garage,garden,garden office,gas central heating,gated access,georgian,grazing land,greenhouse,ground floor,gym,heat pump,high ceilings,hmo,holiday park,home office,hot tub,house,house boat,house share,intercom entry,kitchen island,laminate flooring,land,large garden,leasehold,lift access,listed building,loft,loft conversion,long lease,maisonette,manor,marina,mews,modernised,modern style,mooring,multiple reception rooms,multiple vehicle parking,new build,new homes,no deposit,off street parking,oil central heating,open plan,open plan kitchen,outbuilding,paddock,parking,park home,part exchange,patio,penthouse,period,pet friendly,planning permission,pond,porch,property extension,quiet location,rear extension,refurbished,renovated property,residential area,residential development,retirement home,riverside,river view,roof terrace,rural,sash windows,sauna,scenic views,sea view,semi detached,semi detached bungalow,separate kitchen,separate wc,shared ownership,share of freehold,shed,short term,shower,solar panels,spa facilities,split level,stable,stone built,storage space,student housing,studio,swimming pool,tennis,terraced house,thatched,top floor,townhouse,town centre,underfloor heating,utility room,victorian,village,walk in shower,walk in wardrobe,warehouse,washing machine,waterside living,wet room,wheelchair access,with land,wooden beams,wooden features,wood burner,wood flooring,workshop
tenureTypesarrayOptional list of tenure types for the property. Only applicable when channel is "BUY". Each value must be one of: LEASEHOLD, SHARE_OF_FREEHOLD, FREEHOLD, FEUDAL, COMMONHOLD, NON_TRADITIONAL