Search homes for sale or to let
search_listingsLive homes for sale or to let from participating UK estate agents in a town, outcode or postcode area, with price, bedrooms, type, one photo, the agent's link and when Homedex last checked it was still listed. Use for 'find me a 3-bed flat in Folkestone under £300k'. Up to 20 results, every agent taking turns (fair to all agents), each turn its most detailed then newest listing; pass sort for a plain price or date order, plus how many fit in all and the next 30 as one line each (more_matches): pick the homes that best fit what the person asked for.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | No | A town (Folkestone), outcode (CT20) or postcode (CT20 3TZ). Needed unless near_postcode is given | |
| sort | No | recent (the default: every agent taking turns so no one agent fills the list, each turn its most detailed then newest listing), cheapest first, most expensive first, or newest regardless of agent | |
| limit | No | ||
| cursor | No | For more results: the next_cursor from the previous answer, same filters | |
| channel | No | sale (default) or rent | |
| keywords | No | Words the listing must mention, e.g. garden parking | |
| max_beds | No | ||
| min_beds | No | ||
| max_price | No | ||
| min_price | No | Pounds (monthly rent for rentals) | |
| added_since | No | Only homes Homedex first saw on or after this date (YYYY-MM-DD), for 'what's new since…' | |
| within_miles | No | With near_postcode: how far from it, in miles (default 2, up to 10) | |
| near_postcode | No | Only homes near this full postcode (e.g. CT20 1AA), within within_miles | |
| property_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | Yes | ||
| near | No | ||
| total | No | How many homes fit in all, e.g. '312' or '500 or more' | |
| display | No | Only in apps that show Homedex's home cards: how to show these homes | |
| results | Yes | ||
| next_cursor | No | Pass as cursor, with the same filters, for more results; null when that's all | |
| sold_prices | Yes | ||
| more_matches | No | The next homes that fit, one line each (Homedex number first): pick any that suit the person better, and use get_listing for details |