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

Zoopla Agent Details

GET https://scrappa.co/api/zoopla/agent/{branchId}?branchId=115738

Return available branch and agent details for a Zoopla branch identifier.

Zoopla Agent Details 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zoopla/agent/{branchId}?branchId=115738
Auth header
x-api-key
Cost
1 credit/request
branchId = 115738
Response preview
200 OK
{
    "success": true,
    "branch_id": 115738,
    "branch": {
        "address": "55 Baker Street, London",
        "branchDetailsUri": "/find-agents/branch/knight-frank-prime-central-london-new-homes-london-115738/",
        "branchId": "115738",
        "branchDisplayName": "Knight Frank - Prime Central London New Homes",
        "logoUrl": "https://st.zoocdn.com/zoopla_static_agent_logo_(644071).png",
        "postcode": "W1U 8AN"
    },
    "agent": {
        "memberships": [
            {
...

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.

branchId integer Required

Numeric branch identifier in the route path.

Example value 115738

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zoopla/agent/{branchId}?branchId=115738",
    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/agent/{branchId}?branchId=115738');

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/agent/{branchId}?branchId=115738', 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/agent/{branchId}?branchId=115738',
    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/agent/{branchId}?branchId=115738")
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/agent/{branchId}?branchId=115738", 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/agent/{branchId}?branchId=115738', 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/agent/{branchId}?branchId=115738")
        .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/agent/{branchId}?branchId=115738", 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/agent/{branchId}?branchId=115738"
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/agent/{branchId}?branchId=115738"));
            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/agent/{branchId}?branchId=115738',
            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/agent/{branchId}?branchId=115738")
        .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 branch_id branch agent logo_url
JSON Response
200 OK
{
    "success": true,
    "branch_id": 115738,
    "branch": {
        "address": "55 Baker Street, London",
        "branchDetailsUri": "/find-agents/branch/knight-frank-prime-central-london-new-homes-london-115738/",
        "branchId": "115738",
        "branchDisplayName": "Knight Frank - Prime Central London New Homes",
        "logoUrl": "https://st.zoocdn.com/zoopla_static_agent_logo_(644071).png",
        "postcode": "W1U 8AN"
    },
    "agent": {
        "memberships": [
            {
                "memberOf": "arla",
                "url": "https://www.zoopla.co.uk/tips/agent-affiliation-arla/"
            },
            {
                "memberOf": "rics",
                "url": "https://www.zoopla.co.uk/tips/agent-affiliation-rics/"
            }
        ]
    },
    "logo_url": "https://st.zoocdn.com/zoopla_static_agent_logo_(644071).png"
}

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.