address_lookup
ChatGPTUse for UK address lookup. Send keyword as a full postcode, outward code, local authority name, or free-text address. Set address to any truthy value to force full-text address search. Returns status and data; each result is an address, postcode, first_postcode, or authority item.
audience_landlords
ChatGPTFind landlord/proprietor audiences for properties in one UK area. Provide one area selector: first_postcode, sector_code_list (max 4), or polygon_str (max 15 sq miles). Filter by area ownership, linked agents, director age/count, portfolio size, proprietor type, purchases, sale/rental listings.
audience_letting_property
ChatGPTFind UK rental listings in one area. Provide exactly one area selector: first_postcode, sector_code_list (max 4), or polygon_str (max 15 sq miles). Use progress and filters for tenure, type, beds, ownership, EPC, size, dates, rent, HMO, accessibility, or retirement; return count or data.
audience_selling_property
ChatGPTFind UK sale listings in one area. Provide exactly one area selector: first_postcode, sector_code_list (max 4), or polygon_str (max 15 sq miles). Use progress and filters for tenure, type, beds, ownership, EPC/tax band, size, dates, price, HMO, accessibility, or retirement; return count or data.
get_brandboard
ChatGPTRetrieve broadband availability, speed, and usage data for a place by ID or postcode.
get_broadband
ChatGPTUse when the user asks about broadband availability, speeds, or usage for a UK postcode or place.
get_coal_area
ChatGPTCheck whether a UK latitude/longitude is inside a coal area. Returns a boolean result for environmental risk screening.
get_comparable
ChatGPTRetrieve comparable properties from the external comparables API.
get_comparable_by_property_id
ChatGPTLook up property features by property_id, merge with client overrides, and retrieve comparable properties.
get_credit_balance
ChatGPTUse when the signed-in user asks how many Propalt API credits, balance, or quota their organisation has left.
get_crime
ChatGPTLocal crime data by type for one postcode, LSOA, or local authority. Returns crime category counts, composite totals, and rates per 1,000 residents.
get_demographics
ChatGPTCore socioeconomic area profile for one postcode, LSOA, or local authority. Merges census age distribution, usual residents, population density, migration indicators, current occupation, and economic activity status into one response.
get_epc_fabric_by_postcode
ChatGPTRetrieve EPC fabric data (energy performance, building characteristics, costs) by postcode.
get_epc_fabric_by_property_id
ChatGPTRetrieve EPC fabric data (energy performance, building characteristics, costs) by property_id.
get_households
ChatGPTHousing-specific profile for one postcode, LSOA, or local authority. Merges census household composition, household size, household tenure, and household deprivation into one response.
get_hpi
ChatGPTRetrieve UK House Price Index data for a postcode at Authority or Region geographic level.
get_income
ChatGPTAverage household income for one postcode, LSOA, or local authority. Returns estimated annual income with upper and lower confidence limits.
get_leaseholds
ChatGPTRetrieve leasehold records for a property by property ID.
get_market_activity_get_company_properties
ChatGPTUse when the user explicitly asks for the national UK property portfolio owned by a specific company landlord. This is an expensive lookup; do not use for general ownership questions.
get_market_analysis
ChatGPTRetrieve regional analysis data (property characteristics, energy costs, dwelling counts) by postcode outward code.
get_mining_area
ChatGPTCheck non-coal mining hazard data for a UK latitude/longitude. Returns the matching mining hazard legend and class when present.
get_monthly_market
ChatGPTRetrieve monthly market analysis data (listings, sales, prices, SSTC times, reductions) by postcode outward code.
get_nearby_amenities
ChatGPTUse when the user asks which shops, supermarkets, post offices, banks, ATMs, restaurants, cafes, or parks are near a UK postcode or coordinate.
get_nearby_schools
ChatGPTFind the 20 nearest schools to a postcode or lat/lng location, with full school details.
get_nearby_transport
ChatGPTUse when the user asks which rail, metro, bus stations, or bus stops are near a UK postcode or coordinate. The data is not live timetable or disruption information.
get_place
ChatGPTRetrieve a place record by ID or postcode, enriched with average property floor areas by type.
get_planning_applications
ChatGPTUse when the user asks about planning applications, planning history, or nearby development for a specific UK property, postcode, outward code, or polygon area.
get_planning_constraints_planning_constraints_get
ChatGPTUse when the user asks which planning or environmental constraints affect a UK property or location, such as conservation, heritage, flood, or protected-area constraints.
get_property
ChatGPTRetrieve detailed property information by property_id, uprn, or udprn.
get_property_classifications
ChatGPTUse when the user needs valid AddressBase property or land classification codes, usually before a classification-filtered property or land search.
get_property_history
ChatGPTRetrieve full event history for a property by property_id.
get_quarterly_market
ChatGPTRetrieve quarterly market analysis data (listings, sales, prices, SSTC times, reductions) by postcode outward code.
get_valuation_by_property_id
ChatGPTLook up property features by property_id, merge with client overrides, and retrieve AVM valuation.
landlords_organisation_landlords_post
ChatGPTUse when the user asks to find or count landlord or proprietor prospects in a UK area using ownership, portfolio, company-director, agent, sale, or rental filters. This is an expensive lookup.
letting_property_market_activity_properties_for_let_post
ChatGPTUse when the user wants to find or count UK properties currently or recently offered to rent in a defined area, including rental comparables and achievable-rent evidence.
ping
ChatGPTHealth check — verifies the API is up and the database is reachable.
search_land_property
ChatGPTUse when the user wants to find or count non-residential land parcels or AddressBase land classifications in a UK area. Do not use for ordinary residential property searches.
search_properties
ChatGPTFind UK residential properties in one area. Provide exactly one area selector: first_postcode, sector_code_list (max 4), or polygon_str (max 15 sq miles). Filter by tenure, type, beds, ownership, EPC/tax band, size, urban/density, valuation, sold date, activity windows, or latest event.
search_properties_by_energy
ChatGPTUse when the user asks for UK residential properties matching EPC energy attributes such as heating system, insulation, wall type, or solar (solar panels on the EPC, solar keywords in the listing, or a solar roof lease; not EPC solar water heating) within a postcode, outward code, or town.
selling_property_market_activity_properties_for_sale_post
ChatGPTUse when the user wants to find or count UK properties currently for sale, recently listed, reduced, withdrawn, or sold subject to contract in a defined area.
street_lookup
ChatGPTUse for UK street or location search when the user provides query text. Returns up to 5 Google Places matches with formatted address, latitude and longitude, and the viewport converted to a closed WKT polygon.