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

realestateVIEW agent Listings API Documentation

GET https://scrappa.co/api/realestateview/agent-listings?id=104933

Scrappa's GET /api/realestateview/agent-listings returns the listings of one realestateVIEW agent. Send the numeric id of the agent, which is agents[].id in search and listing results.

What you get

The current for-sale listings in the same shape as search results. Rental and sold history is not part of this endpoint; use search with mode=rent or mode=sold. Prices are in Australian dollars and rent is per week. Image fields are public links.

Pagination

A page holds up to 10 listings. total_results is the full count, pagination.page is always the page you asked for, and a page past the last one returns an empty listings list. Page 1 data is never labelled as another page.

Unknown ids

The source does not tell an unknown id from a agent with no listings. Both answer 200 with an empty list and are billed as a valid empty result. An id that is not a number answers 422.

realestateVIEW agent Listings API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realestateview/agent-listings?id=104933
Auth header
x-api-key
Cost
1 credit/request
id = 104933
Response preview
200 OK
{
    "success": true,
    "agent_id": 104933,
    "total_results": 14,
    "returned": 1,
    "pagination": {
        "page": 1,
        "per_page": 10,
        "total_pages": 2,
        "has_next_page": true
    },
    "listings": [
        {
            "id": 18245247,
...

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.

1 optional filter available.

id string Required

Numeric agent id, for example 104933.

Example value 104933
page integer Optional

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

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/realestateview/agent-listings?id=104933",
    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/agent-listings?id=104933');

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/agent-listings?id=104933', 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/agent-listings?id=104933',
    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/agent-listings?id=104933")
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/agent-listings?id=104933", 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/agent-listings?id=104933', 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/agent-listings?id=104933")
        .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/agent-listings?id=104933", 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/agent-listings?id=104933"
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/agent-listings?id=104933"));
            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/agent-listings?id=104933',
            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/agent-listings?id=104933")
        .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 agent_id total_results returned pagination listings meta

Common listings fields

id status listing_type sale_method
JSON Response
200 OK
{
    "success": true,
    "agent_id": 104933,
    "total_results": 14,
    "returned": 1,
    "pagination": {
        "page": 1,
        "per_page": 10,
        "total_pages": 2,
        "has_next_page": true
    },
    "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": "agent_agency_listings",
        "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": {
        "id": [
            "The id field format is invalid."
        ]
    },
    "message": "The id field format 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": "agent_agency_listings"
    },
    "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.