Pass a suburb slug for one profile, or a bounding box to resolve every suburb inside it in the same single upstream call. Returns the annual median-sold-price series with sale counts and days on market. A year can carry a null median alongside a populated sale count for sparse property types; that is reported as-is. property_type accepts only Unit or House.
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.
5 optional filters available.
integer
Required
Bedroom count the profile is computed for.
2
string
Required
Unit or House. No other value is accepted.
Unit
string
Optional
Suburb slug, for example pyrmont-nsw-2009.
pyrmont-nsw-2009
number
Optional
Bounding-box north-west latitude.
10
number
Optional
Bounding-box north-west longitude.
10
number
Optional
Bounding-box south-east latitude.
10
number
Optional
Bounding-box south-east longitude. All four coordinates are required together; supplying only the latitudes returns a 400.
10
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/domain-com-au/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit",
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit');
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit', 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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit',
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit")
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit", 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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit', 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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit")
.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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit", 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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit"
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit"));
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit',
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/suburb-insights?slug=pyrmont-nsw-2009&bedrooms=2&property_type=Unit")
.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": {
"suburb": {
"name": "Pyrmont",
"postcode": "2009",
"insights": {
"median_sold_price": 1220000,
"annual_growth": -0.043
}
}
}
}
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.