/zoopla/properties/search

POST /api/zoopla/properties/search

Price: 2 credits

Search Zoopla property listings by location (for sale or to rent), with optional bedroom and price filters. Returns listing cards with address, price, bedrooms, bathrooms, reception rooms, floor area, property type, the listing photo, the listing agent and the listing detail url.

How to use it

Search Zoopla listings in a location. location is a town/city/postcode/borough ('london', 'manchester', 'se1'); section selects for-sale or to-rent; beds_min/beds_max/price_min/price_max are optional filters. Each result has id, url, address, title, property_type, price (numeric), price_label, price_qualifier (e.g. Guide price/POA), bedroom_count, bathroom_count, living_room_count, size_sqft, published_at, published_label, image_count, floor_plan_count, video_count, tags, image and agent (id, name, image, phone, url).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location string required — Location to search in: a town, city, postcode area or borough (examples: "london", "manchester", "se1", "bristol"; minLength: 1)
• section string — Whether to search properties for sale or to rent (default: "for-sale"; one of: "for-sale", "to-rent")
• beds_min integer nullable — Minimum number of bedrooms (min: 0)
• beds_max integer nullable — Maximum number of bedrooms (min: 0)
• price_min integer nullable — Minimum price (min: 0)
• price_max integer nullable — Maximum price (min: 0)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "ZooplaSearchListing")
• id string required
• url string nullable
• address string nullable
• property_type string nullable
• price integer nullable
• price_label string nullable
• price_qualifier string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• living_room_count integer nullable
• size_sqft integer nullable
• published_at string nullable
• published_label string nullable
• image_count integer nullable
• floor_plan_count integer nullable
• video_count integer nullable
• tags array (default: [])
• image string nullable
• agent object nullable
  • @type string (default: "ZooplaSearchAgent")
  • id string nullable
  • name string nullable
  • image string nullable
  • phone string nullable
  • url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Location not found (no Zoopla coverage area matches the given location) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.