# realestateVIEW Agency Profile API Documentation

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`.

- **Documentation:** [https://scrappa.co/docs/realestateview-api/realestateview_agency](https://scrappa.co/docs/realestateview-api/realestateview_agency)
- **API group:** realestateVIEW API
- **Endpoint:** `GET https://scrappa.co/api/realestateview/agency`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Numeric agency id from search or listing (agency.id), for example 24798. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/realestateview/agency?id=24798"
```

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | No agency exists with that id (`not_found`). Non-billable. |
| 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. |
| 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)