Skip to main content
POST
/
api
/
zoopla
/
properties
/
search
/zoopla/properties/search
curl --request POST \
  --url https://api.anysite.io/api/zoopla/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "location": "<string>",
  "count": 2,
  "timeout": 300,
  "section": "for-sale",
  "beds_min": 1,
  "beds_max": 1,
  "price_min": 1,
  "price_max": 1
}
'
[
  {
    "id": "<string>",
    "@type": "@zoopla_search_listing",
    "url": "<string>",
    "address": "<string>",
    "title": "<string>",
    "property_type": "<string>",
    "price": 123,
    "price_label": "<string>",
    "price_qualifier": "<string>",
    "bedroom_count": 123,
    "bathroom_count": 123,
    "living_room_count": 123,
    "size_sqft": 123,
    "published_at": "<string>",
    "published_label": "<string>",
    "image_count": 123,
    "floor_plan_count": 123,
    "video_count": 123,
    "tags": [],
    "image": "<string>",
    "agent": {
      "@type": "@zoopla_search_agent",
      "id": "<string>",
      "name": "<string>",
      "image": "<string>",
      "phone": "<string>",
      "url": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required

Location to search in: a town, city, postcode area or borough

Minimum string length: 1
Examples:

"london"

"manchester"

"se1"

"bristol"

count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
section
enum<string>
default:for-sale

Whether to search properties for sale or to rent

Available options:
for-sale,
to-rent
beds_min
integer | null

Minimum number of bedrooms

Required range: x >= 0
beds_max
integer | null

Maximum number of bedrooms

Required range: x >= 0
price_min
integer | null

Minimum price

Required range: x >= 0
price_max
integer | null

Maximum price

Required range: x >= 0

Response

Successful Response

id
string
required
@type
string
default:@zoopla_search_listing
url
string | null
address
string | null
title
string | null
property_type
string | null
price
integer | null
price_label
string | null
price_qualifier
string | null
bedroom_count
integer | null
bathroom_count
integer | null
living_room_count
integer | null
size_sqft
integer | null
published_at
string | null
published_label
string | null
image_count
integer | null
floor_plan_count
integer | null
video_count
integer | null
tags
string[]
image
string | null
agent
ZooplaSearchAgent · object