# Zoopla Search

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/zoopla/search` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 2 credits per call |
| **Documentation** | https://www.piloterr.com/library/zoopla-search |

## Description

Search Zoopla listings from a search URL and retrieve prices, specs, photos, agency info, and pagination.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/zoopla/search' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Search homes for sale in Manchester

```json
{
  "results": [
    {
      "url": "https://www.zoopla.co.uk/new-homes/details/71832056/",
      "image": "https://lid.zoocdn.com/645/430/47fabc16bd9d4a08bf75ae1d2097af505b5914f0.jpg",
      "price": 132300,
      "agency": "Latimer Homes - Islington Wharf",
      "address": "Old Mill Street, Manchester M4",
      "square_ft": 883,
      "just_added": false,
      "description": "Price shown is 35% share of £378,000 full market value.",
      "num_bedrooms": 2,
      "num_bathrooms": 2,
      "price_currency": "Sterling pound £",
      "num_living_room": null
    },
    {
      "url": "https://www.zoopla.co.uk/new-homes/details/72441029/",
      "image": "https://lid.zoocdn.com/645/430/bdc475a4ce5f4d81dd023d14bf099df1155117bd.jpg",
      "price": 87000,
      "agency": "L&Q - Victoria Riverside",
      "address": "Dantzic Street, Manchester M4",
      "square_ft": null,
      "just_added": false,
      "description": "Reserve a 1 or 2 bedroom apartment between 1 – 30 June with a £99 reservation fee and unlock better interest rates with a ...",
      "num_bedrooms": 2,
      "num_bathrooms": 2,
      "price_currency": "Sterling pound £",
      "num_living_room": null
    },
    {
      "url": "https://www.zoopla.co.uk/for-sale/details/71163101/",
      "image": "https://lid.zoocdn.com/645/430/0bd485d8f19088a91bdbf64d62d6493843f530ca.jpg",
      "price": 145000,
      "agency": "Ascend, Manchester",
      "address": "Lexington Court, Broadway, Salford Quays M50",
      "square_ft": null,
      "just_added": false,
      "description": "*Buy To Let Investors Only* - Tenanted at £975pcm Welcome to this charming apartment located in the desirable Lexington ...",
      "num_bedrooms": 2,
      "num_bathrooms": 1,
      "price_currency": "Sterling pound £",
      "num_living_room": 1
    }
  ],
  "pagination": {
    "next": 2,
    "current": 1,
    "other_pages": [],
    "total_pages": 12,
    "has_next_page": true,
    "total_results": 296
  }
}
```

## Documentation

## Overview
Extract property listings from any Zoopla search results page. Returns structured listings with price, address, bedrooms, bathrooms, agency, thumbnail, square footage, and pagination metadata via browser rendering.

## Quickstart
```
GET https://api.piloterr.com/v2/zoopla/search?query=https://www.zoopla.co.uk/for-sale/property/manchester/
```

Filtered search URLs with query parameters (`beds_min`, `price_max`, `q`, etc.) are supported. Copy the full URL from zoopla.co.uk.

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full Zoopla search URL |

## Response fields
| Field | Type | Description |
|---|---|---|
| `results` | array | List of property listings |
| `results[].url` | string | Property detail URL |
| `results[].price` | integer \| null | Listing price |
| `results[].address` | string \| null | Property address |
| `results[].image` | string \| null | Thumbnail image URL |
| `results[].agency` | string \| null | Estate agent name |
| `results[].description` | string \| null | Truncated listing description |
| `results[].num_bedrooms` | integer \| null | Number of bedrooms (`0` for studios) |
| `results[].num_bathrooms` | integer \| null | Number of bathrooms |
| `results[].num_living_room` | integer \| null | Number of reception rooms |
| `results[].square_ft` | integer \| null | Floor area in sq ft |
| `results[].just_added` | boolean | Whether the listing was recently added |
| `results[].price_currency` | string | Currency label |
| `pagination.current` | integer | Current page number |
| `pagination.next` | integer \| null | Next page number |
| `pagination.total_pages` | integer | Total pages |
| `pagination.total_results` | integer | Total matching listings |
| `pagination.other_pages` | array | Other available page numbers |
| `pagination.has_next_page` | boolean | Whether a next page exists |

## Notes
- Response is returned under `results` with a `pagination` object.
- Only full Zoopla search URLs are accepted as `query`.
- Supports for-sale, to-rent, and new-homes search pages, including filtered URLs copied from zoopla.co.uk.
- Append `?pn=2` to the URL for pagination.
- Some cards may return partial data (`price`, `address`, `agency`, `image`, or room counts as `null`).
- Pass a property detail URL to the Zoopla Property endpoint for full listing data.

## Main use cases
- Monitor for-sale and rental inventory across UK cities
- Build lead lists with price, specs, and agency attribution
- Feed property discovery pipelines for real estate analytics
- Track pagination across Zoopla search result pages