Skip to content
Scrappa Get API key
Realestate.com.au API 1 credit/request

Realestate.com.au Search

GET https://scrappa.co/api/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&page=1

Search Australian real estate listings by loading public realestate.com.au search pages through browser-orchestrator and extracting the embedded ArgonautExchange data. Supports buy, rent, and sold channels plus mapped URL filters such as price, bedrooms, bathrooms, parking, property types, keywords, pagination, and sorting.

Realestate.com.au Search 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&page=1
Auth header
x-api-key
Cost
1 credit/request
location = Sydney, NSW
Response preview
200 OK
{
    "success": true,
    "data": {
        "channel": "buy",
        "location": "Sydney, NSW",
        "total_results": 1,
        "listings": [
            {
                "id": "143160680",
                "url": "https://www.realestate.com.au/property-house-vic-tarneit-143160680",
                "property_type": "House",
                "price": "$650,000"
            }
        ]
...

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.

11 optional filters available.

location string Required

Location search text such as Sydney, NSW.

Example value Sydney, NSW
channel string Optional

Listing channel: buy, rent, or sold.

Example value buy
page integer Optional

Page number.

Example value 1
sort string Optional

realestate.com.au sort type, such as new-desc or sold-date-desc.

Example value relevance
min_price integer Optional

Minimum price filter.

Example value 10
max_price integer Optional

Maximum price filter.

Example value 10
min_bedrooms integer Optional

Minimum bedroom count.

Example value 10
max_bedrooms integer Optional

Maximum bedroom count.

Example value 10
min_bathrooms integer Optional

Minimum bathroom count.

Example value 10
min_carspaces integer Optional

Minimum parking spaces.

Example value 10
property_types string Optional

Comma-separated realestate.com.au property types, such as house, townhouse, unit+apartment or land.

Example value example
keywords string Optional

Comma-separated keyword filters.

Example value running shoes

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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/realestate-com-au/search?location=Sydney%2C+NSW&channel=buy&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 data
JSON Response
200 OK
{
    "success": true,
    "data": {
        "channel": "buy",
        "location": "Sydney, NSW",
        "total_results": 1,
        "listings": [
            {
                "id": "143160680",
                "url": "https://www.realestate.com.au/property-house-vic-tarneit-143160680",
                "property_type": "House",
                "price": "$650,000"
            }
        ]
    }
}

Errors

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

VALIDATION_ERROR

HTTP VALIDATION_ERROR

Request validation failed.

UPSTREAM_BLOCKED

HTTP UPSTREAM_BLOCKED

Realestate.com.au returned a challenge without parseable page data.

upstream_unavailable

HTTP upstream_unavailable

The upstream service is temporarily unavailable. Please retry shortly.

upstream_unavailable

HTTP upstream_unavailable

The upstream service is temporarily unavailable. Please retry shortly.

upstream_unavailable

HTTP upstream_unavailable

The upstream service is temporarily unavailable. Please retry shortly.

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.