propertiesv2list
Search UK properties for sale or rent using location, price, bedrooms, property type, and other detailed filters to find matching listings.
Instructions
List properties for sale or rent with options and filters
Query Parameters:
locationValue (Required): The value of geoLabel field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of name field returned in .../house-prices/v2/get-area (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working.
locationIdentifier (Required): The value of geoIdentifier field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of id field returned in ..../house-prices/v2/get-area endpoint (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint.
category: One of the following residential|commercial
furnishedState: One of the following : Any|furnished|part_furnished|unfurnished
includeRented: Example value:
includeRetirementHomes: Example value:
includeSharedAccommodation: Example value:
includeSharedOwnership: Example value:
includeSold: Example value:
isAuction: Example value:
petsAllowed: Example value:
billsIncluded: Example value:
keywords: Any word or term, ex : garden,wooden floors
section: One of the following : for-sale|to-rent
bedsMax: Max number of bed rooms (1 - 10)
bedsMin: Min number of bed rooms (1 - 10)
priceMax: Maximum sale or rent price
priceMin: Minimum sale or rent price
sortOrder: One of the following : newest_listings|highest_price|lowest_price|most_reduced
page: The page index for paging purpose
radius: The radius (miles) to look for properties (0.25 - 40)
priceFrequency: One of the following per_month|per_year
newHomes: One of the following : only|exclude
added: Recently added. One of the following : 24_hours|3_days|7_days|14_days|30_days
propertySubType: Filter properties by category. Ignore OR one of the followings (Separated by comma for multiple options) : park_home,bungalow,farms_land,terraced,flats,semi_detached,detached
chainFree: Example value:
reducedPriceOnly: Example value:
feature: One of the followings : has_balcony_terrace|has_parking_garage|has_garden . Separated by comma for multiple options. Ex : has_balcony_terrace,has_parking_garage,...
tenure: One of the followings : share_of_freehold|freehold|leasehold. Ex : freehold,leasehold,...
smartTags: One of the followings : condition.needs_modernisation|architecture.period_property|type.cottage|style.modern|attributes.utility_room|attributes.basement|attributes.conservatory|attributes.home_office|attributes.bath|attributes.en_suite|attributes.patio|attributes.kitchen_island. Ex : condition.needs_modernisation,architecture.period_property,...
Responses:
200 (Success): Successful response
Content-Type:
application/json
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| locationValue | Yes | The value of geoLabel field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of name field returned in .../house-prices/v2/get-area (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. | |
| locationIdentifier | Yes | The value of geoIdentifier field returned in .../v2/auto-complete endpoint with listings as search_type. Or the value of id field returned in ..../house-prices/v2/get-area endpoint (If you are searching by postal code). You must use EXACTLY the value returned by the endpoint. | |
| category | No | One of the following residential|commercial | |
| furnishedState | No | One of the following : Any|furnished|part_furnished|unfurnished | |
| includeRented | No | Example value: | |
| includeRetirementHomes | No | Example value: | |
| includeSharedAccommodation | No | Example value: | |
| includeSharedOwnership | No | Example value: | |
| includeSold | No | Example value: | |
| isAuction | No | Example value: | |
| petsAllowed | No | Example value: | |
| billsIncluded | No | Example value: | |
| keywords | No | Any word or term, ex : garden,wooden floors | |
| section | No | One of the following : for-sale|to-rent | |
| bedsMax | No | Max number of bed rooms (1 - 10) | 0 |
| bedsMin | No | Min number of bed rooms (1 - 10) | 0 |
| priceMax | No | Maximum sale or rent price | 0 |
| priceMin | No | Minimum sale or rent price | 0 |
| sortOrder | No | One of the following : newest_listings|highest_price|lowest_price|most_reduced | |
| page | No | The page index for paging purpose | 1 |
| radius | No | The radius (miles) to look for properties (0.25 - 40) | 0 |
| priceFrequency | No | One of the following per_month|per_year | |
| newHomes | No | One of the following : only|exclude | |
| added | No | Recently added. One of the following : 24_hours|3_days|7_days|14_days|30_days | |
| propertySubType | No | Filter properties by category. Ignore OR one of the followings (Separated by comma for multiple options) : park_home,bungalow,farms_land,terraced,flats,semi_detached,detached | |
| chainFree | No | Example value: | |
| reducedPriceOnly | No | Example value: | |
| feature | No | One of the followings : has_balcony_terrace|has_parking_garage|has_garden . Separated by comma for multiple options. Ex : has_balcony_terrace,has_parking_garage,... | |
| tenure | No | One of the followings : share_of_freehold|freehold|leasehold. Ex : freehold,leasehold,... | |
| smartTags | No | One of the followings : condition.needs_modernisation|architecture.period_property|type.cottage|style.modern|attributes.utility_room|attributes.basement|attributes.conservatory|attributes.home_office|attributes.bath|attributes.en_suite|attributes.patio|attributes.kitchen_island. Ex : condition.needs_modernisation,architecture.period_property,... |