mode selects the listing type: buy, rent, sold, new-homes or rural. Commercial is not available and returns a 400. The platform fixes a page at ten listings and ignores any larger page size, so paginate with page. A promotional row is interleaved into every result page and is filtered out before counting. Facet counts are not available on any reachable surface, so this endpoint filters but does not aggregate. Numeric prices are only populated by the property endpoint, so price_exact is null here while display_price carries the formatted figure. Several suburbs may be passed at once via suburbs[]; each is searched independently.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
20 optional filters available.
string
Optional
buy, rent, sold, new-homes, or rural. Commercial is refused with a 400 — the platform exposes no commercial listings on its anonymous search API.
buy
string
Optional
Suburb name, for example Pyrmont.
Pyrmont
string
Optional
Up to 20 suburb names. Each is searched as its own location; combining them with suburb sends them all.
example
string
Optional
Region name, for example Inner West.
US
string
Optional
State name, for example NSW.
NSW
string
Optional
Postcode, for example 2009.
example
integer
Optional
1-based page number. Ten listings per page.
1
integer
Optional
Lower bedroom bound.
10
integer
Optional
Upper bedroom bound.
10
integer
Optional
Lower price bound in AUD.
10
integer
Optional
Upper price bound in AUD.
10
string
Optional
House, Apartment, Townhouse, Land, Rural, NewApartments, NewHomeDesigns, or NewHouseLand.
example
integer
Optional
Lower bathroom bound.
10
integer
Optional
Upper bathroom bound.
10
integer
Optional
Lower carspace bound.
10
integer
Optional
Upper carspace bound.
10
integer
Optional
Lower land-area bound in square metres.
10
integer
Optional
Upper land-area bound in square metres.
10
string
Optional
HasPhotos, HasPrice, HasMatterport, NotUpForAuction, MarkedAsNew, or NotUnderContract.
example
string
Optional
Sold mode only: ALL, LAST_WEEK, LAST_MONTH, LAST_THREE_MONTHS, LAST_SIX_MONTHS, LAST_YEAR, or LAST_TWO_YEARS.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&page=1');
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/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&page=1', 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/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&page=1"
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/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&page=1"));
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/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&page=1',
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/domain-com-au/search?mode=buy&suburb=Pyrmont&state=NSW&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
{
"success": true,
"data": {
"mode": "buy",
"total_results": 82,
"total_pages": 9,
"page": 1,
"page_size": 10,
"listings": [
{
"listing_id": 2021204457,
"display_address": "1202/2-4 Mount Street, Walk, Pyrmont NSW 2009",
"display_price": "Asking Price: $11,400,000"
}
]
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is invalid, including an unrecognised mode, property type or enum. Accepted values are listed in the error. This response is not billable.
Not Found
The requested listing, agent profile or city was not found. This response is not billable.
Upstream Input Rejected
Domain.com.au refused the requested filters, or an identifier could not be resolved. This response is not billable.
Service Unavailable
The service could not reach its data source, or the lookup did not complete. No credits are charged for a failed request.
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.