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

Domain.com.au Locations

GET https://scrappa.co/api/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009

Returns matched properties with their suburb, state and postcode, plus the suburbs neighbouring a supplied slug. Supplying suburb_slug alongside q returns structured neighbouring suburbs; without it the suggestion list for that operation is empty.

Domain.com.au Locations 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009
Auth header
x-api-key
Cost
1 credit/request
q = pyrmont
Response preview
200 OK
{
    "success": true,
    "data": {
        "suggested_properties": [
            {
                "address": "166 Pyrmont Street, Pyrmont NSW 2009",
                "postcode": "2009"
            }
        ],
        "suggested_suburbs": [
            {
                "name": "Glebe",
                "state": "NSW",
                "postcode": "2037"
...

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.

4 optional filters available.

q string Required

Free-text address or suburb fragment.

Example value pyrmont
suburb_slug string Optional

Slug whose neighbouring suburbs are returned, for example pyrmont-nsw-2009.

Example value pyrmont-nsw-2009
mode string Optional

sale or rent. Selects which neighbourhood set is returned.

Example value example
channel string Optional

ALL (default), RESIDENTIAL, or COMMERCIAL.

Example value example
page_size integer Optional

Rows per page, up to 50.

Example value 10

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009",
    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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009');

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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009', 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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009',
    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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009")
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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009", 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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009', 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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009")
        .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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009", 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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009"
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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009"));
            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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009',
            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/domain-com-au/locations?q=pyrmont&suburb_slug=pyrmont-nsw-2009")
        .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": {
        "suggested_properties": [
            {
                "address": "166 Pyrmont Street, Pyrmont NSW 2009",
                "postcode": "2009"
            }
        ],
        "suggested_suburbs": [
            {
                "name": "Glebe",
                "state": "NSW",
                "postcode": "2037"
            }
        ]
    }
}

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.