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

realestateVIEW Agency Profile API Documentation

GET https://scrappa.co/api/realestateview/agency?id=24798

Scrappa's GET /api/realestateview/agency returns the public profile of one realestateVIEW agency. Send the numeric id, which is agency.id in search and listing results.

What you get

name, slug, address, suburb, postcode, city, state, lga, lat, lng, logo_url, brand_colour, website, phone, sales_email, rental_email, description, social, stats, sales_performance, rent_performance and top_suburbs. Prices are in Australian dollars.

Hidden address

An agency can hide its address. Then address, lat and lng are null.

Listings

Use /api/realestateview/agency-listings for the listings of the agency.

Unknown ids

An id that realestateVIEW does not know answers 404 (not_found) and is not billed. An id that is not a number answers 422.

realestateVIEW Agency Profile API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/realestateview/agency?id=24798
Auth header
x-api-key
Cost
1 credit/request
id = 24798
Response preview
200 OK
{
    "success": true,
    "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/",
        "city": "Melbourne",
        "state": "VIC",
...

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.

id string Required

Numeric agency id from search or listing (agency.id), for example 24798.

Example value 24798

Request Examples

PHP
<?php

$curl = curl_init();

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

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/agency?id=24798', 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/agency?id=24798',
    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/agency?id=24798")
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/agency?id=24798", 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/agency?id=24798', 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/agency?id=24798")
        .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/agency?id=24798", 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/agency?id=24798"
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/agency?id=24798"));
            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/agency?id=24798',
            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/agency?id=24798")
        .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 agency meta
JSON Response
200 OK
{
    "success": true,
    "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/",
        "city": "Melbourne",
        "state": "VIC",
        "lga": "Melbourne Council",
        "brand_contrast_colour": "F4F7F8",
        "website": "https://example.com",
        "phone": "1300000000",
        "sales_email": "sales@example.com",
        "rental_email": null,
        "description": "Sample Realty sold 23 properties in the last 12 months.",
        "lat": -37.812733,
        "lng": 144.959665,
        "social": [],
        "stats": {
            "average_days_on_market": 171,
            "average_leased_days_on_market": 59,
            "average_sold_price": 612894.61,
            "average_leased_price": 747.19,
            "sold_listings": 23,
            "leased_listings": 137,
            "buy_listings": 13,
            "rent_listings": 7
        },
        "sales_performance": [],
        "rent_performance": [],
        "top_suburbs": []
    },
    "meta": {
        "endpoint_family": "agency_profile",
        "billable": true,
        "attempts": 1
    }
}

Errors

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

404

Not Found

No agency exists with that id (`not_found`). Non-billable.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "endpoint_family": "agency_profile"
    },
    "error": {
        "code": "not_found",
        "message": "No realestateVIEW record exists with that identifier."
    },
    "success": false
}
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": "agency_profile"
    },
    "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.