Skip to content
Scrappa Get API key
Zoopla API 1 credit/request

Zoopla Search

GET https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1

Search current Zoopla property listings for a UK location and return listing results with pagination and location details. Important limitation: this endpoint supports section, location and page only. The underlying data source ignores price, bedroom and property-type filters on this search plane, so a filtered request would return unfiltered results and appear to succeed. Known filter parameters are rejected with a 422 rather than silently ignored, but that rejection covers a fixed list of parameter names: because the upstream ignores filter parameters entirely, an unrecognised filter spelling may still return unfiltered results, so verify the returned listing set if you apply your own filters. For price, bedroom or property-type filtering, filter the /api/zoopla/search response client-side. The /api/zoopla/sold endpoint filters by last-sale date only (from_last_sale_date, to_last_sale_date); it exposes no price, bedroom or property-type filter.

Zoopla Search 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1
Auth header
x-api-key
Cost
1 credit/request
location = sw1a
Response preview
200 OK
{
    "success": true,
    "section": "for-sale",
    "location": "sw1a",
    "results": [
        {
            "listingId": "70469141",
            "title": "Two bedroom flat",
            "price": 625000,
            "address": "Westminster, London"
        }
    ],
    "pagination": {
        "page": 1,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

2 optional filters available.

location string Required

Location name or geographic identifier, such as sw1a.

Example value sw1a
section string Optional

Listing section, such as for-sale or to-rent. Defaults to for-sale.

Example value for-sale
page integer Optional

Result page number. Defaults to 1.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/zoopla/search?section=for-sale&location=sw1a&page=1", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/zoopla/search?section=for-sale&location=sw1a&page=1")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success section location results pagination geo silent_empty

Common results fields

listingId title price address
JSON Response
200 OK
{
    "success": true,
    "section": "for-sale",
    "location": "sw1a",
    "results": [
        {
            "listingId": "70469141",
            "title": "Two bedroom flat",
            "price": 625000,
            "address": "Westminster, London"
        }
    ],
    "pagination": {
        "page": 1,
        "page_size": 25,
        "total_results": 39,
        "total_results_was_limited": false
    },
    "geo": {
        "geoIdentifier": "sw1a",
        "label": "SW1A"
    },
    "silent_empty": false
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

401

Unauthorized

Authentication is required to use this endpoint.

{
    "error": {
        "code": "UNAUTHORIZED",
        "message": "Authentication is required."
    },
    "success": false
}
422

Validation Error

One or more input parameters are missing or invalid.

{
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "One or more input parameters are invalid."
    },
    "success": false
}
404

Integration Disabled

This integration is currently disabled on the server. Availability is switched per environment, so it can be off during a staged rollout.

{
    "error": {
        "code": "ZOOPLA_DISABLED",
        "message": "Zoopla requests are disabled."
    },
    "success": false
}
500

Internal Error

The request could not be processed because of a fault in this service, not the data source. No credit is charged.

{
    "error": {
        "code": "ZOOPLA_INTERNAL_ERROR",
        "message": "The request could not be processed."
    },
    "success": false
}
503

Unusable Upstream Response

The data source answered but the response could not be used: empty, oversized, undecodable, or carrying errors with no usable data. No credit is charged.

{
    "error": {
        "code": "ZOOPLA_UPSTREAM_SHAPE",
        "message": "The data source returned an unusable response."
    },
    "success": false
}
503

Upstream Unavailable

The data source could not complete this request. Try again later.

{
    "error": {
        "code": "ZOOPLA_UPSTREAM_UNAVAILABLE",
        "message": "The data source is temporarily unavailable."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.