# Realestateview — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and explore rental property listings across Australia with detailed information including photos, property types, agent details, and nearby listings. Find available rentals by location, compare properties, and discover similar listings in your area of interest.

**Category:** Real Estate | **Website:** [realestateview.com.au/](https://realestateview.com.au/) | **Docs:** [parse.bot/marketplace/fb16cd7b-0f80-44c9-ae29-b3bb6a6ff31b/realestateview-com-au-api](https://parse.bot/marketplace/fb16cd7b-0f80-44c9-ae29-b3bb6a6ff31b/realestateview-com-au-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get agent listings

Get an agent's profile details including contact information, agency details, listing statistics, and performance data. Returns stale_input if the agent profile is not found.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `agent_url` | string | Yes | Relative URL path of the agent profile page (e.g. '/agent-profile/agent-name-123456/'). Obtainable from search_rental_listings results[*].agents[*].agentProfileLink. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/get-agent-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"agent_url":"<string>"}'
```

### Get listing images

Get images and floor plans associated with a specific property listing. Returns the listing ID, all property images, the hero image URL, and any floor plan files.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_url` | string | Yes | Relative URL path of the listing detail page (e.g. '/property/vic/richmond-3121/1-sample-street-12345678/'). Obtainable from search_rental_listings results[*].listingDetailLink. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/get-listing-images \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listing_url":"<string>"}'
```

### Get nearby listings

Get similar/nearby listings for a specific property. Extracts the similarListings array from the listing detail page. Returns stale_input if the listing no longer exists.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_url` | string | Yes | Relative URL path of the property listing page (e.g. '/property/vic/richmond-3121/1-sample-street-12345678/'). Obtainable from search_rental_listings results[*].listingDetailLink. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/get-nearby-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listing_url":"<string>"}'
```

### Get property types

Get the list of property type categories supported by view.com.au. Returns all five property types with their slug IDs for use in search_rental_listings property_type parameter.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/get-property-types \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get rental listing detail

Retrieve full details of a specific property listing including description, features, images, similar listings, suburb trends, nearby schools, and zoning information. Returns stale_input if the listing no longer exists.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_url` | string | Yes | Relative URL path of the listing detail page (e.g. '/property/vic/richmond-3121/1-sample-street-12345678/'). Obtainable from search_rental_listings results[*].listingDetailLink. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/get-rental-listing-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"listing_url":"<string>"}'
```

### Search locations

Search for locations (suburbs, postcodes, LGAs, cities) by keyword. Useful for discovering valid suburb/postcode values for search_rental_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword for location lookup (e.g. 'Richmond', 'Yarra', '3121'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/search-locations \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### Search rental listings

Search for rental listings on view.com.au with optional filters for location, property type, and bedrooms. Returns paginated results with 25 listings per page. Without filters returns all VIC rentals. Combine state + suburb + postcode for locality-specific results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms` | string | No | Number of bedrooms filter. Provide as a number string (e.g. '2') or slug (e.g. '2-bedrooms'). |
| `page` | integer | No | Page number for pagination. |
| `postcode` | string | No | Australian postcode (e.g. '3121', '2000'). Leading zeros preserved. |
| `property_type` | string | No | Property type slug used in URL path. |
| `state` | string | No | Australian state code in lowercase. |
| `suburb` | string | No | Suburb name. Spaces are converted to hyphens internally (e.g. 'richmond', 'hoppers crossing'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/realestateview/search-rental-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms":"<string>","page":"<integer>","postcode":"<string>","property_type":"<string>","state":"<string>","suburb":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.