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

Property.com.au Location Autocomplete API Documentation

GET https://scrappa.co/api/property-com-au/autocomplete?query=Bondi&limit=3

Scrappa's GET /api/property-com-au/autocomplete suggests Australian suburbs, postcodes, states, regions and street addresses for the start of a name.

Use the result

  • For a place (suburb, postcode, state, region), pass search_location as location to /api/property-com-au/search. It is the exact text the search accepts, for example Bondi Beach, NSW 2026.
  • For an address, pid is the property id and listing_path is a path you pass as path to /api/property-com-au/listing. An address is one property, not a place, so search_location is null.

Fields

Each suggestion has id, type, text, subtext, suburb, state, postcode, street, search_location, pid and listing_path. type limits the kinds returned: a comma-separated list of suburb, postcode, state, region, address. The default is all five.

Property.com.au Location Autocomplete API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/property-com-au/autocomplete?query=Bondi&limit=3
Auth header
x-api-key
Cost
1 credit/request
query = Bondi
Response preview
200 OK
{
    "success": true,
    "data": [
        {
            "id": "9795ffbe-fdfb-40b3-86be-47b22cba6cfe-2026",
            "type": "suburb",
            "text": "Bondi Beach, NSW 2026",
            "subtext": "Suburb",
            "suburb": "Bondi Beach",
            "state": "NSW",
            "postcode": "2026",
            "street": null,
            "search_location": "Bondi Beach, NSW 2026",
            "pid": null,
...

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.

2 optional filters available.

query string Required

Start of a place or address, at least 2 characters.

Example value Bondi
type string Optional

Comma-separated: suburb, postcode, state, region, address. Default: all five.

Example value example
limit integer Optional

Suggestions to return, 1-10 (default 6).

Example value 3

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/property-com-au/autocomplete?query=Bondi&limit=3",
    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/property-com-au/autocomplete?query=Bondi&limit=3');

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/property-com-au/autocomplete?query=Bondi&limit=3', 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/property-com-au/autocomplete?query=Bondi&limit=3',
    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/property-com-au/autocomplete?query=Bondi&limit=3")
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/property-com-au/autocomplete?query=Bondi&limit=3", 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/property-com-au/autocomplete?query=Bondi&limit=3', 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/property-com-au/autocomplete?query=Bondi&limit=3")
        .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/property-com-au/autocomplete?query=Bondi&limit=3", 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/property-com-au/autocomplete?query=Bondi&limit=3"
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/property-com-au/autocomplete?query=Bondi&limit=3"));
            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/property-com-au/autocomplete?query=Bondi&limit=3',
            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/property-com-au/autocomplete?query=Bondi&limit=3")
        .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 meta

Common data fields

id type text subtext
JSON Response
200 OK
{
    "success": true,
    "data": [
        {
            "id": "9795ffbe-fdfb-40b3-86be-47b22cba6cfe-2026",
            "type": "suburb",
            "text": "Bondi Beach, NSW 2026",
            "subtext": "Suburb",
            "suburb": "Bondi Beach",
            "state": "NSW",
            "postcode": "2026",
            "street": null,
            "search_location": "Bondi Beach, NSW 2026",
            "pid": null,
            "listing_path": null
        },
        {
            "id": "11740812",
            "type": "address",
            "text": "10 Lamrock Ave, Bondi Beach, NSW 2026",
            "subtext": "Property history",
            "suburb": "Bondi Beach",
            "state": "NSW",
            "postcode": "2026",
            "street": "10 Lamrock Ave",
            "search_location": null,
            "pid": 11740812,
            "listing_path": "/nsw/bondi-beach-2026/lamrock-ave/10-pid-11740812/"
        }
    ],
    "meta": {
        "endpoint_family": "autocomplete",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

422

Validation Error

A query parameter is missing, unknown or unusable. Unknown parameters are rejected, never ignored. Non-billable.

{
    "errors": {
        "sort": [
            "The selected sort is invalid."
        ]
    },
    "message": "The selected sort is invalid."
}
503

Upstream Unavailable

Property.com.au could not be reached after retries or answered with something unusable (`upstream_unavailable`, `upstream_blocked`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 3,
        "billable": false,
        "retryable": true,
        "endpoint_family": "autocomplete"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Property.com.au is temporarily unavailable. Please retry."
    },
    "success": false
}

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.