Skip to content
Scrappa Get API key

Realestate.com.au Suburb Profile

Fetch a public realestate.com.au suburb or Market Explorer page through browser-orchestrator and return embedded profile and market data when available.

Run this endpoint

Realestate.com.au Suburb Profile 1 credit/request

Endpoint

GET https://scrappa.co/api/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F
Request preview GET
https://scrappa.co/api/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F
Auth header x-api-key
Cost 1 credit/request
url = https://www.realestate.com.au/australia/
Response preview 200 OK
{
    "success": true,
    "data": {
        "url": "https://www.realestate.com.au/australia/",
        "profile": []
    }
}

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.

url string Required
Open example

Full realestate.com.au suburb or market profile URL.

Example value https://www.realestate.com.au/australia/

Request Examples

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F",
    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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F');

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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F', 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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F',
    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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F")
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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F", 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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F', 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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F")
        .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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F", 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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F"
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/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F"));
            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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F',
            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/realestate-com-au/suburb-profile?url=https%3A%2F%2Fwww.realestate.com.au%2Faustralia%2F")
        .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": {
        "url": "https://www.realestate.com.au/australia/",
        "profile": []
    }
}

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.

BROWSER_ORCHESTRATOR_UNAVAILABLE

HTTP BROWSER_ORCHESTRATOR_UNAVAILABLE

The browser-orchestrator session service is not configured or unavailable.

EMPTY_BROWSER_RESPONSE

HTTP EMPTY_BROWSER_RESPONSE

Browser-orchestrator returned an empty Realestate.com.au document.

SOLVER_UNAVAILABLE

HTTP SOLVER_UNAVAILABLE

The lightweight autocomplete or sales-events solver is not configured.

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.