Search Property24 listings for sale or to rent in a suburb, city, province or estate. Get the location id and location_type from locations/autocomplete. Filters by price, minimum bedrooms and property type are applied by Property24. Minimum bathrooms are matched on the returned listings, so a page can hold fewer than 21 items; filtered_out shows how many were removed. A listing that breaks a requested filter is never returned. The page in the response always equals the page you asked for.
Run this endpoint
Endpoint
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.
8 optional filters available.
integer
Required
Location id from locations/autocomplete.
432
integer
Required
Type from locations/autocomplete: 1 suburb, 2 city, 5 province, 13 estate. Regions (4) are not supported.
2
string
Optional
sale or rent. Default sale.
sale
string
Optional
house, apartment, townhouse, vacant_land, farm, commercial or industrial. Default all types.
example
integer
Optional
Minimum price in rand.
10
integer
Optional
Maximum price in rand.
10
integer
Optional
Minimum bedrooms. Not for land, farm, commercial or industrial.
2
integer
Optional
Minimum bathrooms, matched on the returned listings. Not for land, farm, commercial or industrial.
10
string
Optional
newest, price_low or price_high.
price_low
integer
Optional
Page number, starting at 1. Maximum 50.
1
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low",
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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low', 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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low',
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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low")
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
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/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
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/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low")
.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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low", 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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low"
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/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/property24/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
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/search?location_id=432&location_type=2&deal_type=sale&min_bedrooms=2&sort=price_low")
.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
deal_type
property_type
location
total_filtered_results
total_pages
filtered_out
+1 more
Common results fields
listing_id
path
url
deal_type
{
"success": true,
"page": 1,
"deal_type": "sale",
"property_type": null,
"location": {
"id": 432,
"type": 2,
"type_label": "city",
"name": "Cape Town"
},
"total_filtered_results": 702,
"total_pages": 36,
"filtered_out": 0,
"results": [
{
"listing_id": "117555220",
"path": "/for-sale/wynberg/cape-town/western-cape/10109/117555220",
"url": "https://www.property24.com/for-sale/wynberg/cape-town/western-cape/10109/117555220",
"deal_type": "sale",
"title": "2 Bedroom Apartment / flat for sale in Wynberg - Cape Town",
"price": 1125000,
"price_text": "R 1 125 000",
"location": "Wynberg",
"description": "Bright & Welcoming 2 Bedroom Apartment First floor 2 bedroom apartment in Wynberg Village ...",
"bedrooms": 2,
"bathrooms": 1,
"parking_spaces": 1,
"erf_size_m2": null,
"floor_size_m2": 55,
"images": [
"https://images.prop24.com/385319368/Crop600x400"
],
"agency": {
"id": 30696,
"slug": "hqm-properties",
"name": "HQM Properties",
"logo": "https://images.prop24.com/349180118/Ensure264x153"
},
"agent_name": null,
"ribbons": [
"Reduced"
]
}
]
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
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
}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
}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.