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

Property24 Agencies Directory

GET https://scrappa.co/api/property24/agencies?location_id=432&location_type=2

Directory of estate agencies for a city, 20 per page: name, logo, description and the number of listings for sale and to rent. Use a city id from locations/autocomplete (location_type 2).

Property24 Agencies Directory 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/property24/agencies?location_id=432&location_type=2
Auth header
x-api-key
Cost
1 credit/request
location_id = 432 location_type = 2
Response preview
200 OK
{
    "success": true,
    "page": 1,
    "location": {
        "id": 432,
        "type": 2,
        "type_label": "city",
        "name": "Cape Town"
    },
    "total_filtered_results": 642,
    "total_pages": 33,
    "results": [
        {
            "agency_id": 30732,
...

Parameters

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

Runnable path

2 required parameters needed before sending a request.

1 optional filter available.

location_id integer Required

City id from locations/autocomplete.

Example value 432
location_type integer Required

Must be 2 (city).

Example value 2
page integer Optional

Page number, starting at 1. Maximum 50.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/property24/agencies?location_id=432&location_type=2",
    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/property24/agencies?location_id=432&location_type=2');

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/property24/agencies?location_id=432&location_type=2', 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/property24/agencies?location_id=432&location_type=2',
    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/property24/agencies?location_id=432&location_type=2")
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/property24/agencies?location_id=432&location_type=2", 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/property24/agencies?location_id=432&location_type=2', 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/property24/agencies?location_id=432&location_type=2")
        .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/property24/agencies?location_id=432&location_type=2", 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/property24/agencies?location_id=432&location_type=2"
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/property24/agencies?location_id=432&location_type=2"));
            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/property24/agencies?location_id=432&location_type=2',
            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/property24/agencies?location_id=432&location_type=2")
        .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 page location total_filtered_results total_pages results

Common results fields

agency_id slug name logo
JSON Response
200 OK
{
    "success": true,
    "page": 1,
    "location": {
        "id": 432,
        "type": 2,
        "type_label": "city",
        "name": "Cape Town"
    },
    "total_filtered_results": 642,
    "total_pages": 33,
    "results": [
        {
            "agency_id": 30732,
            "slug": "titan-property-group",
            "name": "TITAN Property Group",
            "logo": "https://images.prop24.com/337732832/Fit600x300",
            "sale_listing_count": 207,
            "rent_listing_count": 1551
        }
    ]
}

Errors

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

404

Not Found

The listing, agency or location does not exist or is no longer online. The request is not charged.

{
    "error": {
        "code": "not_found",
        "message": "Nothing was found for that request."
    },
    "success": false
}
422

Unsupported Location Type

Regions (location_type 4) cannot be searched. Use a suburb, city, province or estate id.

{
    "error": {
        "code": "unsupported_location_type",
        "message": "This location type is not supported. Use a suburb, city, province or estate."
    },
    "success": false
}
503

Upstream Unavailable

Property24 returned an unsuccessful, empty or unexpected answer. The request is not charged.

{
    "error": {
        "code": "upstream_unavailable",
        "message": "The service is temporarily unavailable. Please retry shortly."
    },
    "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.