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

Property24 Agency Profile

GET https://scrappa.co/api/property24/agency?agency_id=30696&slug=hqm-properties

Profile of one estate agency: name, about text, areas serviced, number of listings for sale and to rent, and the featured agents. Get agency_id and slug from the agency field of a search result or from the agencies directory. Phone numbers and street addresses are not published and not returned.

Property24 Agency Profile 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/property24/agency?agency_id=30696&slug=hqm-properties
Auth header
x-api-key
Cost
1 credit/request
agency_id = 30696 slug = hqm-properties
Response preview
200 OK
{
    "success": true,
    "agency": {
        "agency_id": 30696,
        "slug": "hqm-properties",
        "name": "HQM Properties",
        "about": "Be it SALES, RENTALS or Property Management, our focus is your needs.",
        "areas_serviced": [
            {
                "name": "Cape Town",
                "path": "/for-sale/cape-town/western-cape/432"
            }
        ],
        "sale_listing_count": 6,
...

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.

agency_id integer Required

Agency id, for example 30696.

Example value 30696
slug string Required

Agency slug, for example hqm-properties.

Example value hqm-properties

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/property24/agency?agency_id=30696&slug=hqm-properties",
    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/agency?agency_id=30696&slug=hqm-properties');

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/agency?agency_id=30696&slug=hqm-properties', 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/agency?agency_id=30696&slug=hqm-properties',
    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/agency?agency_id=30696&slug=hqm-properties")
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/agency?agency_id=30696&slug=hqm-properties", 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/agency?agency_id=30696&slug=hqm-properties', 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/agency?agency_id=30696&slug=hqm-properties")
        .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/agency?agency_id=30696&slug=hqm-properties", 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/agency?agency_id=30696&slug=hqm-properties"
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/agency?agency_id=30696&slug=hqm-properties"));
            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/agency?agency_id=30696&slug=hqm-properties',
            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/agency?agency_id=30696&slug=hqm-properties")
        .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 agency
JSON Response
200 OK
{
    "success": true,
    "agency": {
        "agency_id": 30696,
        "slug": "hqm-properties",
        "name": "HQM Properties",
        "about": "Be it SALES, RENTALS or Property Management, our focus is your needs.",
        "areas_serviced": [
            {
                "name": "Cape Town",
                "path": "/for-sale/cape-town/western-cape/432"
            }
        ],
        "sale_listing_count": 6,
        "rent_listing_count": 7,
        "agents": [
            {
                "id": 482138,
                "name": "Chris Muller",
                "role": "Property Practitioner"
            }
        ]
    }
}

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
}
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.