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

realestateVIEW Property Search API Documentation

GET https://scrappa.co/api/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2

Scrappa's GET /api/realestateview/search returns Australian property for sale, for rent or sold on realestateVIEW as structured JSON. Set mode=buy, mode=rent or mode=sold and give one suburb.

What you get

Each listing has id, status, listing_type, price_text, price_numeric, rent_per_week, sold_price, sold_on, beds, baths, cars, land_size_sqm, property_type, address, lat, lng, images, inspections, auction_at, the dates the listing was created and updated, agents and the agency. Prices are in Australian dollars and rent is per week. Image fields are public links.

One suburb per search

Take state, suburb and postcode from /api/realestateview/location-autocomplete. A search covers that suburb only, never its neighbours. To cover several suburbs, send one request per suburb.

Filters are honoured

Beds, baths and car spaces take a minimum (_min) or an exact value (_exact), not both. The portal can return a listing that breaks a filter, so every listing is checked again. A listing that breaks a filter is never returned and is counted in filtered_out_count. applied_filters echoes what was used.

Hidden prices

Many agents hide the price. With price_min or price_max, a listing with a hidden or zero price is left out, because it cannot be shown to match. Without a price filter such a listing is returned with is_price_hidden set to true and price_numeric empty. A price of 0 is never shown as a price.

Sorting

recommended is the default. price_asc and price_desc sort by price. newest sorts by listing date and recently_updated by the last change. bedrooms_asc and bedrooms_desc sort by bedrooms. Listings with a hidden price can lead a price sort.

Pagination

page is 1-based and a page holds up to 25 listings. pagination.page is always the page you asked for. The portal serves the first 9 pages of a search, about 200 listings (pagination.max_pages). A page past the last one returns an empty listings list with the true total_results, never the data of another page. Narrow the search with filters to reach the rest.

realestateVIEW Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2
Auth header
x-api-key
Cost
1 credit/request
mode = buy state = vic suburb = Melbourne
Response preview
200 OK
{
    "success": true,
    "total_results": 538,
    "total_results_is_estimate": false,
    "returned": 1,
    "filtered_out_count": 0,
    "pagination": {
        "page": 1,
        "per_page": 25,
        "total_pages": 9,
        "max_pages": 9,
        "has_next_page": true
    },
    "applied_filters": {
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

4 required parameters needed before sending a request.

14 optional filters available.

mode string Required

buy for sale listings, rent for rental listings or sold for sold listings.

Example value buy
state string Required

State code from location-autocomplete: act, nsw, nt, qld, sa, tas, vic or wa.

Example value vic
suburb string Required

Suburb name from location-autocomplete, for example Melbourne.

Example value Melbourne
postcode string Required

Four-digit postcode from location-autocomplete, for example 3000.

Example value 3000
property_types string Optional

house, apartment, apartment_unit, studio, townhouse, villa, land or rural. Repeat the parameter or separate with commas.

Example value example
beds_min integer Optional

Minimum number of bedrooms. Do not combine with beds_exact.

Example value 2
beds_exact integer Optional

Exact number of bedrooms.

Example value 10
baths_min integer Optional

Minimum number of bathrooms. Do not combine with baths_exact.

Example value 10
baths_exact integer Optional

Exact number of bathrooms.

Example value 10
cars_min integer Optional

Minimum number of car spaces. Do not combine with cars_exact.

Example value 10
cars_exact integer Optional

Exact number of car spaces.

Example value 10
price_min integer Optional

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

Example value 10
price_max integer Optional

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

Example value 10
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
exclude_under_contract boolean Optional

true to leave out listings that are under contract.

Example value true
sort string Optional

recommended (default), price_asc, price_desc, newest, recently_updated, bedrooms_asc or bedrooms_desc.

Example value relevance
page integer Optional

Result page, 1-based. Each page holds up to 25 listings.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2",
    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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2');

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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2', 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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2',
    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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2")
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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2", 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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2', 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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2")
        .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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2", 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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2"
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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2"));
            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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2',
            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/realestateview/search?mode=buy&state=vic&suburb=Melbourne&postcode=3000&beds_min=2")
        .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 status listing_type sale_method
JSON Response
200 OK
{
    "success": true,
    "total_results": 538,
    "total_results_is_estimate": false,
    "returned": 1,
    "filtered_out_count": 0,
    "pagination": {
        "page": 1,
        "per_page": 25,
        "total_pages": 9,
        "max_pages": 9,
        "has_next_page": true
    },
    "applied_filters": {
        "mode": "buy",
        "state": "vic",
        "suburb": "Melbourne",
        "postcode": "3000",
        "beds_min": 2,
        "sort": "recommended"
    },
    "listings": [
        {
            "id": 18245247,
            "status": "On Market",
            "listing_type": "sale",
            "sale_method": "Sale",
            "listing_path": "/property/vic/melbourne-3000/1409-260-spencer-street-18245247/",
            "price_text": "$645,000",
            "price_numeric": 645000,
            "price_to": null,
            "is_price_hidden": false,
            "rent_per_week": null,
            "sold_price": null,
            "is_sold_price_hidden": false,
            "sold_on": null,
            "beds": 2,
            "baths": 2,
            "cars": 0,
            "land_size_sqm": 84,
            "property_type": "Apartment & Unit",
            "property_types": [
                "Apartment & Unit"
            ],
            "source_property_type": "Apartment",
            "is_new_construction": false,
            "is_home_and_land": false,
            "address": {
                "unit_number": "1409",
                "street_number": "260",
                "street": "Spencer Street",
                "suburb": "Melbourne",
                "postcode": "3000",
                "state": "VIC",
                "city": "Melbourne",
                "region": "Melbourne",
                "lga": "Melbourne Council",
                "gnaf_id": "GAVIC720552251",
                "is_street_hidden": false
            },
            "lat": -37.814655,
            "lng": 144.952675,
            "images": [
                {
                    "sequence": 1,
                    "caption": null,
                    "url": "https://view.com.au/viewstatic/images/listing/2-bedroom-apartment-in-melbourne-vic-3000/750-w/18245247-1-D2A9EB3.jpg",
                    "thumbnail_url": "https://view.com.au/viewstatic/images/listing/2-bedroom-apartment-in-melbourne-vic-3000/400-w/18245247-1-D2A9EB3.jpg",
                    "large_url": "https://view.com.au/viewstatic/images/listing/2-bedroom-apartment-in-melbourne-vic-3000/1200-w/18245247-1-D2A9EB3.jpg"
                }
            ],
            "inspections": [
                {
                    "starts_at": "2026-10-31 12:00:00",
                    "ends_at": "2026-10-31 12:15:00"
                }
            ],
            "auction_at": null,
            "created_at": "2026-10-26 07:50:49",
            "updated_at": "2026-10-26 07:50:55",
            "on_market_at": "2026-10-26 07:50:49",
            "agents": [
                {
                    "id": 104933,
                    "name": "Sample Agent",
                    "first_name": "Sample",
                    "last_name": "Agent",
                    "position": null,
                    "phone": "1300 000 000",
                    "mobile": "0400 000 000",
                    "email": null,
                    "photo_url": null,
                    "profile_path": "/agent-profile/sample-agent-104933/",
                    "agency_id": null,
                    "sold_listings": 16,
                    "average_sold_price": 569161
                }
            ],
            "agency": {
                "id": 24798,
                "name": "Sample Realty",
                "slug": "sample-realty",
                "address": "Suite 1, Level 2, 34 Sample Street, Melbourne, VIC 3000",
                "suburb": "Melbourne",
                "postcode": "3000",
                "logo_url": "https://view.com.au/viewstatic/images/listing/300-min/f9a416dc651440608bd7cbc8b2450bae.png",
                "brand_colour": "00202F",
                "profile_path": "/real-estate-agency/sample-realty-24798/"
            }
        }
    ],
    "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

realestateVIEW 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": "realestateVIEW 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.