Search homes
search_homesUse this when the user wants to find homes for sale or to rent in the UK. Give a place (town, area or postcode) and any budget, bedrooms or type they mention. Put what they want from the home or area in their own words in wishes (for example "a garden", "walk to a station", "good primary schools nearby", "within 45 minutes of King's Cross"); homes are then ranked by fit, each with a 0-100 match score and the evidence behind it (station and school distances, advertised features). Put a physical feature they insist on and an advert would state ("garage", "annexe") in must_haves; anything about lifestyle or the area ("near the sea", "wild swimming", "good schools") always goes in wishes. Returns up to 10 homes with price, bedrooms, agent and a link, and for each home what is nearby: the nearest primary and secondary schools with their Ofsted grade, station, park, GP surgery, supermarket and broadband.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | ||
| limit | No | Default 6. | |
| place | Yes | One UK place: a town, city, district, county, region, national park, National Landscape, named coast, island or postcode, e.g. "Harrogate", "Dorset", "the Lake District", "the South West", "the south coast", "Jersey", "LS6". Each is searched as one whole area. "near Totnes" takes in about 3 miles around it. | |
| wishes | No | What the user wants, in their words. Homes are ranked by how well they match. | |
| max_beds | No | ||
| min_beds | No | ||
| max_price | No | Pounds. For rent, per calendar month. | |
| min_price | No | Pounds. For rent, per calendar month. | |
| must_haves | No | A physical feature the advert must state word for word, e.g. "garage". Never lifestyle or area wishes: those go in wishes. | |
| buy_or_rent | No | Default buy. | |
| property_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| homes | Yes | ||
| place | No | ||
| towns | No | For a coast or national park: the towns searched, each with its search on MyPorta. | |
| more_url | No | The same search on MyPorta, with every result. | |
| place_found | No | False when MyPorta did not recognise the place; no homes are returned then. |