Skip to content
Scrappa Get API key
Homely API 1 credit/request

Homely Property Search API Documentation

GET https://scrappa.co/api/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20

Scrappa's GET /api/homely/search returns Australian property for sale or rent on Homely as structured JSON. Set mode=buy or mode=rent.

What you get

Each listing has id, url_slug, listing_type, property_type, title, description, price_text, price_numeric, bond, beds, baths, cars, area_sqm, building_sqm, address, lat, lng, tags, inspections, images, floor_plans, documents, videos, agents and the office id and name. Only available listings are returned: sold and leased history is not part of this endpoint.

Prices are text

Homely publishes the price as text, for example "Offers over $650,000". price_text holds it as published. price_numeric is set only when the text holds one clear figure, and is null otherwise. Rent is quoted per week. The price filters are applied by Homely, so they act on its own price data.

Filters are honoured

Beds, baths and car spaces are minimums. property_types takes house, unit, apartment, townhouse, villa, acreage, retirement, studio or other. Homely ignores a filter it does not know, so beds, baths, cars, type, land size and location are checked again on every listing. A listing that breaks a filter is never returned and is counted in filtered_out_count. applied_filters echoes what was used.

Location is approximate

Homely has no suburb filter. Take location and postcode from /api/homely/location-autocomplete. The search looks the suburb name up as a keyword and then drops every listing from another suburb or postcode. A page can hold fewer than per_page listings, even none, while later pages still hold results. total_results is then the keyword total, an upper bound, and total_results_is_estimate is true.

Sorting

newest is the default and oldest is the reverse. expensive lists the highest rent first and works with mode=rent only. Homely returns sale prices in no reliable price order, so price sort is not offered for sale.

Pagination

page is 1-based and per_page is 1-50 (default 20). pagination.page is always the page you asked for. A page past the last one returns an empty listings list, never another page's data.

Homely Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20
Auth header
x-api-key
Cost
1 credit/request
mode = buy
Response preview
200 OK
{
    "success": true,
    "total_results": 9120,
    "total_results_is_estimate": false,
    "returned": 1,
    "filtered_out_count": 0,
    "pagination": {
        "page": 1,
        "per_page": 20,
        "total_pages": 456,
        "has_next_page": true
    },
    "applied_filters": {
        "mode": "buy",
...

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.

13 optional filters available.

mode string Required

buy for sale listings or rent for rental listings.

Example value buy
location string Optional

Suburb name from location-autocomplete, for example Bondi.

Example value Austin, Texas
postcode string Optional

Four-digit postcode from location-autocomplete. Needs location.

Example value example
property_types string Optional

house, unit, apartment, townhouse, villa, acreage, retirement, studio or other. Repeat the parameter or separate with commas.

Example value house
beds_min integer Optional

Minimum number of bedrooms.

Example value 3
baths_min integer Optional

Minimum number of bathrooms.

Example value 10
cars_min integer Optional

Minimum number of car spaces.

Example value 10
price_min integer Optional

Minimum price in Australian dollars. For rent this is per week.

Example value 10
price_max integer Optional

Maximum price in Australian dollars. For rent this is per week.

Example value 1000000
land_size_min integer Optional

Minimum land size in square metres.

Example value 10
land_size_max integer Optional

Maximum land size in square metres.

Example value 10
sort string Optional

newest (default), oldest or expensive (rent only).

Example value relevance
page integer Optional

Result page, 1-based.

Example value 1
per_page integer Optional

Listings per page, 1-50 (default 20).

Example value 20

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20",
    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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20');

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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20', 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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20',
    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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20")
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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20", 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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20', 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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20")
        .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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20", 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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20"
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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20"));
            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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20',
            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/homely/search?mode=buy&property_types=house&beds_min=3&price_max=1000000&per_page=20")
        .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 total_results total_results_is_estimate returned filtered_out_count pagination applied_filters listings +1 more

Common listings fields

id url_slug listing_type property_type
JSON Response
200 OK
{
    "success": true,
    "total_results": 9120,
    "total_results_is_estimate": false,
    "returned": 1,
    "filtered_out_count": 0,
    "pagination": {
        "page": 1,
        "per_page": 20,
        "total_pages": 456,
        "has_next_page": true
    },
    "applied_filters": {
        "mode": "buy",
        "property_types": [
            "house"
        ],
        "beds_min": 3,
        "price_max": 1000000,
        "sort": "newest"
    },
    "listings": [
        {
            "id": 13634827,
            "url_slug": "31-eden-street-dudley-park-wa-6210",
            "listing_type": "sale",
            "property_type": "house",
            "status": "available",
            "tier": "basic",
            "is_exclusive": false,
            "title": "Entry-Level Opportunity in Prime Location!",
            "description": "Step into charm, character, and an unbeatable location with this delightful 3-bedroom home.",
            "municipality": null,
            "published_on": "2026-10-26T06:06:46.120Z",
            "last_modified": "2026-10-26T06:07:07.726Z",
            "price_text": "$650,000",
            "price_numeric": 650000,
            "price_period": null,
            "bond": null,
            "listed_on": "2026-10-26T06:06:46.120Z",
            "available_on": null,
            "under_offer": false,
            "sold_price_text": null,
            "sold_on": null,
            "leased_on": null,
            "beds": 3,
            "baths": 1,
            "cars": 3,
            "ensuites": 0,
            "living_areas": 0,
            "open_spaces": 0,
            "toilets": 1,
            "other_features": null,
            "tags": [],
            "area_sqm": 446,
            "building_sqm": 135,
            "is_new_construction": false,
            "address": {
                "full": "31 Eden Street, Dudley Park WA 6210",
                "street_number": "31",
                "unit_number": null,
                "street": "Eden Street",
                "suburb": "Dudley Park",
                "suburb_id": 5717676,
                "state": "WA",
                "postcode": "6210"
            },
            "lat": -32.5401732,
            "lng": 115.7287333,
            "inspections": [
                {
                    "starts_on": "2026-10-31T02:00:00.000Z",
                    "ends_on": "2026-10-31T02:30:00.000Z"
                }
            ],
            "images": [
                {
                    "identifier": "l-VaultRE-13634827-1",
                    "version": "5Sa7thaTM3AZqJgYYa7gm4h4pKKKI2zf",
                    "url": "https://example.com/photo-1.jpg"
                }
            ],
            "floor_plans": [],
            "documents": [],
            "videos": [],
            "external_links": [],
            "agents": [
                {
                    "id": 1077857,
                    "name": "Sample Agent",
                    "email": "agent@example.com",
                    "phone": "(08) 5550 0100",
                    "mobile": "0400 000 000"
                }
            ],
            "office": {
                "id": 38010,
                "name": "Sample Realty Mandurah"
            }
        }
    ],
    "meta": {
        "endpoint_family": "search",
        "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 (`request_rejected` is the same failure raised by the source). Non-billable.

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

Source Unavailable

Homely could not be reached in time, refused the request, or its answer changed shape (`upstream_unavailable`, `request_blocked`, `deadline_exhausted`, `parser_drift`). Retryable and never billed. Clients are never rate limited.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "upstream_unavailable",
        "message": "Homely 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.