area_stats
Sold prices and energy ratings for an area
Sold-price figures for a UK postcode area from HM Land Registry: median and quartile prices over the last 12 months (overall and by detached, semi-detached, terraced, flat), medians by year, and by postcode sector, plus energy-rating counts where loaded. Use it for questions like 'what do flats sell for in CT20?' or 'how have prices changed in Canterbury CT1?'. Pass an outcode (the first half of a postcode, e.g. CT20), a full postcode, or a town that has a single outcode; for a town with several (Folkestone: CT18, CT19, CT20) the reply lists them, so ask about one. Only covers areas Homedex has loaded; if an area isn't covered, the reply lists the ones that are. These are sold prices, not asking prices or valuations.
Parametersarearequired
nearby_sold
Recent sales near a postcode
Recent standard sales registered with HM Land Registry near a UK postcode, newest first, with price, date, address, property type, tenure and distance. Use it for 'what have houses on this street / near this postcode sold for?'. Land Registry records usually appear 1–3 months after completion. Only covers areas Homedex has loaded.
Parameterslimitmonthspostcoderequiredradius_kmproperty_type
search_listings
Search homes for sale or to let
Live 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, the most detailed listings first, then newest, with every agent taking turns (fair to all agents); 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.
Parametersareasortlimitcursorchannelkeywordsmax_bedsmin_bedsmax_pricemin_priceadded_sincewithin_miles+2 more
get_listing
Full details of one home
Everything about one listing by its Homedex number (e.g. HX-CT20-00084): price, rooms, tenure, floor area, energy rating, council tax band, description, all photos, the agent, when Homedex last checked it was still on the agent's website (last_checked), and recent sales within 500 m from HM Land Registry. Send the person to agent_url to book a viewing.
Parametershomedex_norequired
coverage
How complete Homedex is in an area
An ESTIMATE of how much of an area's homes for sale Homedex has, and how many of the local estate agents it knows of have joined, for a town, outcode or postcode (and its local authority). Use it to say honestly how complete answers are, e.g. 'Homedex covers about 55% of homes for sale in CT20'. Always describe the figure as an estimate.
Parametersarearequired
health
Check Homedex is working
Returns ok and the running version. For monitoring; not needed for answers.
Takes no parameters.
search
Search Homedex homes (one plain-English query)
Searches homes for sale or to let from participating UK estate agents with one plain-English query, e.g. '3 bed house in Folkestone under £300k' or 'flats to rent CT20'. Name a town, outcode or postcode. Returns up to 20 results, each with an id to pass to fetch. Made for apps that use standard search and fetch tools (ChatGPT deep research); search_listings takes the same filters separately.
Parametersqueryrequired
fetch
Full details of one Homedex home
The full details of one home by the id that search returned (its Homedex number, e.g. HX-CT20-00012), as text: price, rooms, description, the agent, when Homedex last checked it was still on the agent's website, and the link for viewings and enquiries, which go to the agent. Made for apps that use standard search and fetch tools (ChatGPT deep research); get_listing returns the same as structured data.
Parametersidrequired
