propertieslist_deprecated
Search UK properties for sale or rent using detailed filters like location, price, beds, and property type. This deprecated tool retrieves listings from Zoopla's database.
Instructions
List properties for sale or rent with options and filters
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | Yes | The value of suggestions/value json object returned in .../auto-complete endpoint with listings as search_type. You must use EXACTLY the value returned by the endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. | |
| identifier | No | The value of suggestions/identifier json object returned in .../auto-complete endpoint with listings as search_type. You must use EXACTLY the value returned by the endpoint. | |
| listing_id | No | The value of listing_id field returned right in this endpoint. *'listing_id' OR 'area' parameter must be provided to get this endpoint working. | |
| category | No | One of the following residential|commercial | |
| created_since | No | The date time from which properties added. The format must be yyyy-MM-dd HH:mm:ss, Ex : 2020-09-16 15:00:00 | |
| furnished | No | One of the following furnished|part_furnished|unfurnished | |
| include_featured_properties | No | One of the following 1 | 0 | 0 |
| include_rented | No | One of the following 1 | 0 | 0 |
| include_retirement_homes | No | One of the following yes | no | |
| include_shared_accommodation | No | One of the following yes | no | |
| include_shared_ownership | No | One of the following yes | no | |
| include_sold | No | One of the following 1 | 0 | 0 |
| keywords | No | Any word or term, ex : garden,wooden floors | |
| listing_status | No | One of the following sale | rent | |
| maximum_beds | No | Max number of bed rooms (1 - 10) | 0 |
| minimum_beds | No | Min number of bed rooms (1 - 10) | 0 |
| maximum_price | No | Maximum sale or rent price | 0 |
| minimum_price | No | Minimum sale or rent price | 0 |
| order_by | No | One of the following age|price|price_change|view_count | |
| ordering | No | One of the following ascending|descending | |
| page_number | No | The page index for paging purpose | 1 |
| page_size | No | The number of items per response (max 40) | 40 |
| property_type | No | One of the following and separated by comma for multiple values : flats|farms_land|terraced|semi_detached|detached|bungalow|park_home|offices|retail|industrial|hospitality|land | |
| radius | No | The radius (miles) to look for properties (1 - 40) | 0 |
| pets_allowed | No | One of the following yes | no | |
| price_frequency | No | One of the following per_month|per_year | |
| step_back_used | No | One of the following 1 | 0 | 0 |
| bills_included | No | One of the following yes | no | |
| floor_area_max | No | Maximum floor area, only use with commercial category. | 0 |
| floor_area_min | No | Minimum floor area, only use with commercial category. | 0 |
| floor_area_units | No | One of the following sq_feet|sq_metres | |
| new_homes | No | One of the following yes | no |