Realestate.com.au Autocomplete
Fetch realestate.com.au consumer-suggest autocomplete results. This is the endpoint used by public search boxes for suburbs, regions, states, postcodes, precincts, addresses, schools, and projects depending on the types parameter.
Run this endpoint
Endpoint
https://scrappa.co/api/realestate-com-au/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode
https://scrappa.co/api/realestate-com-au/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode
x-api-key
query
= Sydney CBD, NSW
{
"success": true,
"data": {
"query": "Sydney CBD, NSW",
"types": "suburb,region,precinct,state,postcode",
"suggestions": []
}
}
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.
3 optional filters available.
string
Required
Autocomplete search term.
Sydney CBD, NSW
integer
Optional
Maximum suggestions to return.
7
string
Optional
Comma-separated suggestion types, e.g. suburb,region,precinct,state,postcode,address.
suburb,region,precinct,state,postcode
string
Optional
Client source sent to consumer-suggest, e.g. homepage-web, property-seeker, or reax-multi-intent-search-modal.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/realestate-com-au/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode",
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode');
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode', 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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode',
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode")
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode", 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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode', 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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode")
.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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode", 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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode"
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode"));
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode',
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/autocomplete?query=Sydney+CBD%2C+NSW&limit=7&types=suburb%2Cregion%2Cprecinct%2Cstate%2Cpostcode")
.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
{
"success": true,
"data": {
"query": "Sydney CBD, NSW",
"types": "suburb,region,precinct,state,postcode",
"suggestions": []
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP VALIDATION_ERROR
Request validation failed.
HTTP UPSTREAM_BLOCKED
Realestate.com.au returned a challenge without parseable page data.
HTTP BROWSER_ORCHESTRATOR_UNAVAILABLE
The browser-orchestrator session service is not configured or unavailable.
HTTP EMPTY_BROWSER_RESPONSE
Browser-orchestrator returned an empty Realestate.com.au document.
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.