realestateview APIrealestateview.com.au ↗
Access Australian rental listings, agent profiles, suburb trends, and location data from view.com.au via 7 structured endpoints.
What is the realestateview API?
The view.com.au API exposes 7 endpoints covering rental property listings, agent profiles, and location discovery across Australia. search_rental_listings returns paginated results with 25 listings per page, filterable by state, suburb, postcode, bedrooms, and property type. get_rental_listing_detail goes deeper, returning fields like suburbTrends, featureList, nearby schools, and zoning data for a specific property.
curl -X GET 'https://api.parse.bot/scraper/3748ab7b-6679-4ef0-81af-8c5c885033c3/search_rental_listings?page=1&state=vic&suburb=richmond&bedrooms=2&postcode=3121&property_type=house' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace realestateview-com-au-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: View.com.au Real Estate API — search rentals, drill into listings, explore agents."""
from parse_apis.view_com_au_real_estate_api import (
View, AustralianState, PropertyType_, ResourceNotFound,
)
client = View()
# Search for 2-bedroom houses for rent in VIC
for listing in client.searchresults.search(
state=AustralianState.VIC,
property_type=PropertyType_.HOUSE,
bedrooms="2",
limit=3,
):
print(listing.suburb_name, listing.price_text, listing.bedrooms, "bed")
# Take one listing and get its images
listing = client.searchresults.search(
state=AustralianState.VIC, limit=1
).first()
if listing:
media = listing.images()
print(f"Listing {listing.id}: {len(media.images)} images, hero={media.hero_image}")
# Get similar listings nearby
for similar in listing.similar(limit=3):
print(f" Similar: {similar.price_text} in {similar.suburb_name}")
# Get the first agent's full profile
if listing.agents:
agent_summary = listing.agents[0]
try:
profile = agent_summary.profile()
print(f"Agent: {profile.first_name} {profile.last_name}, "
f"rentals: {profile.number_of_rent_listings}")
except ResourceNotFound:
print("Agent profile no longer available")
# Search locations to discover suburbs
for loc in client.locations.search(query="Richmond", limit=5):
print(loc.display_text, loc.state, loc.postcode)
# List all supported property types
for pt in client.propertytypes.list(limit=10):
print(pt.id, pt.name)
print("exercised: searchresults.search / listing.images / listing.similar / "
"agent.profile / locations.search / propertytypes.list")
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.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number for pagination. |
| state | string | Australian state code in lowercase. |
| suburb | string | Suburb name. Spaces are converted to hyphens internally (e.g. 'richmond', 'hoppers crossing'). |
| bedrooms | string | Number of bedrooms filter. Provide as a number string (e.g. '2') or slug (e.g. '2-bedrooms'). |
| postcode | string | Australian postcode (e.g. '3121', '2000'). Leading zeros preserved. |
| property_type | string | Property type slug used in URL path. |
{
"type": "object",
"fields": {
"total": "integer total number of matching listings across all pages",
"listings": "array of listing objects with property details, agent info, images, and links",
"page_size": "integer number of listings per page (typically 25)",
"current_page": "integer current page number"
},
"sample": {
"data": {
"total": 12679,
"listings": [
{
"id": 17967638,
"state": "VIC",
"agency": {
"id": 4748,
"name": "Ray White Sunbury"
},
"agents": [
{
"id": 104198,
"mobile": "0411 918 077",
"lastName": "Dawson",
"firstName": "Nowelle",
"agentProfileLink": "/agent-profile/nowelle-dawson-104198/"
}
],
"status": "On Market",
"bedrooms": 3,
"carparks": 4,
"postcode": "3427",
"bathrooms": 1,
"priceText": "$515 per week",
"streetName": "Screen Road",
"suburbName": "DIGGERS REST",
"rentPerWeek": 515,
"propertyTypes": [
"House"
],
"listingDetailLink": "/property/vic/diggers-rest-3427/5-screen-road-17967638/"
}
],
"page_size": 25,
"current_page": 1
},
"status": "success"
}
}About the realestateview API
Rental Listing Search and Detail
search_rental_listings accepts optional filters including state, suburb, postcode, bedrooms, and property_type. Without filters it returns all Victorian rentals. Combine all three locality parameters — state, suburb, and postcode — for the most specific results. The response includes total (matching listings across all pages), page_size (always 25), and a listings array with property details, agent info, images, and direct links. Use get_property_types to retrieve the five valid property_type slugs before constructing a filtered search.
Listing Detail and Media
get_rental_listing_detail returns a full property record: priceText, bedrooms, bathrooms, description, featureList, a nested agency object, an agents array with contact details, and a suburbTrends object containing demographic and market trend data for the surrounding suburb. If a listing URL is no longer active, the endpoint returns a stale_input signal rather than an error. get_listing_images fetches the same listing's media separately, returning an images array with url, sequence, and caption, a hero_image URL, and a floor_plans array.
Agent Profiles and Similar Listings
get_agent_listings accepts a relative agent profile URL and returns structured contact data — email, mobile, firstName, lastName — alongside performance fields: averageSoldPrice, numberOfRentListings, and numberOfSoldListings. Agent URLs are obtainable from listing results. get_nearby_listings takes the same listing URL format and returns a similar_listings array, each entry carrying id, priceText, bedrooms, bathrooms, images, agents, and listingDetailLink.
Location Discovery
search_locations accepts a free-text query — suburb name, postcode, or LGA — and returns a data array of location objects. Each object includes suburbName, postcode, state, locationType, lgaName, and displayText. This endpoint is the recommended starting point for building valid locality parameter combinations for search_rental_listings.
The realestateview API is a managed, monitored endpoint for realestateview.com.au — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when realestateview.com.au changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official realestateview.com.au API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build a rental property search interface filtered by suburb, postcode, and bedroom count using
search_rental_listings. - Display full property detail pages including floor plans and suburb trend data with
get_rental_listing_detail. - Aggregate agent contact details and performance statistics from
get_agent_listingsfor a real estate CRM. - Populate a location autocomplete widget using the
suburbName,postcode, andstatefields fromsearch_locations. - Render a 'similar properties' carousel on a listing page using the
similar_listingsarray fromget_nearby_listings. - Build a property image gallery component using the
images,hero_image, andfloor_plansreturned byget_listing_images. - Monitor rental inventory changes across Victorian suburbs by polling
search_rental_listingswith specific postcode and property type filters.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does view.com.au have an official developer API?+
What does `get_rental_listing_detail` return beyond basic listing fields?+
bedrooms, bathrooms, and priceText, the endpoint returns a suburbTrends object with demographic and market trend data, a featureList array, a full description string, nearby school data, and zoning information. The agency and agents fields carry structured contact details.Does the API cover properties for sale, not just rentals?+
Are listings available for all Australian states, or only Victoria?+
search_rental_listings defaults to all VIC rentals when no filters are applied, but the state parameter accepts any lowercase Australian state code. Coverage breadth for non-VIC states depends on the inventory listed on view.com.au at query time.What happens when a listing URL passed to `get_rental_listing_detail` is no longer active?+
stale_input signal rather than throwing an error. The same behaviour applies to get_agent_listings and get_nearby_listings when the referenced resource no longer exists.