- Previous: Average Sold Prices
- Up: Introduction
- Next: Get Session ID
Property Listings
Description: Retrieve property listings for a given area.
Access URI:
https://api.zoopla.co.uk/api/v1/property_listings
Get interactive - Try it now on IO-Docs
Input parameters
In addition to the standard area location parameters, the input parameters detailed below are also accepted.
Key name | Description |
---|---|
radius (compulsory) | When providing a latitude and longitude position, this is the radius from the position to find listings. Minimum radius 0.1 miles, maximum radius is 40 miles. |
order_by | The value which the results should be ordered, either "price" (default) or "age" of listing. |
ordering | Sort order for the listings returned. Either "descending" (default) or "ascending". |
listing_status | Request a specific listing status. Either "sale" or "rent". |
include_sold | Whether to include property listings that are already sold in the results when searching for sale listings, either "1" or "0". Defaults to 0. |
include_rented | Whether to include property listings that are already rented in the results when searching for rental listings, either "1" or "0". Defaults to 0. |
minimum_price | Minimum price for the property, in GBP. When listing_status is "sale" this refers to the sale price and when listing_status is "rent" it refers to the per-week price. |
maximum_price | Maximum price for the property, in GBP. |
minimum_beds | The minimum number of bedrooms the property should have. |
maximum_beds | The maximum number of bedrooms the property should have. |
furnished | Specify whether or not the apartment is "furnished", "unfurnished" or "part-furnished". This parameter only applies to searches related to rental property. |
property_type | Type of property, either "houses" or "flats". |
new_homes | Specifying "yes"/"true" will restrict to only new homes, "no"/"false" will exclude them from the results set. |
chain_free | Specifying "yes"/"true" will restrict to chain free homes, "no"/"false" will exclude them from the results set. |
keywords | Keywords to search for within the listing description. |
listing_id | A specific listing_id to request updated details for. This value can be submitted several times to request several listings, but please note that other provided arguments will still be taken into account when filtering listings. |
branch_id | A specific branch_id to request listings for. This branch idea should correspond to a known branch ID from the Zoopla Web site. |
page_number | The page number of results to request, default 1. |
page_size | The size of each page of results, default 10, maximum 100. |
summarised | Specifying "yes"/"true" will return a cut-down entry for each listing with the description cut short and the following fields will be removed: price_change, floor_plan. |
Generated output
Key name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
result_count | Total number of results in this data set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
listing | Each listing in the result set is contained with a listing element with the following key/value pairs:
|
- Previous: Average Sold Prices
- Up: Introduction
- Next: Get Session ID