How to get properties list

You need to fetch a clean, filterable list of Australian properties and ship it this week. By the end of this guide you’ll be able to query a real properties feed, paginate through results, extract listing details you care about, and optionally drill into a single property — all via one API key on Zyla API Hub.

What you can build with the properties list

The Australia Realty API returns structured lists of properties across Australia with metadata like total result counts, resolved search localities, and tiered listings. Typical uses include:

• Building a search UI to explore sold or rental history by region or suburb.
• Generating daily property digests or alerts sorted by newest listings.
• Enriching internal dashboards with listing counts and pagination-aware fetches.

This post focuses on the “Get Properties List” endpoint to return a page of listings with filters and sorting, and shows how to retrieve details for a specific property when you need them.

Getting started on Zyla API Hub

On Zyla, you use a single account, a single API key, and a subscription + quota model for every API. For Australia Realty API, you can start with a 7-day trial or 50 requests depending on current access options. There is no Free Plan; check the API page for current access options and pricing.

Steps:

1. Open the Australia Realty API page on Zyla.
2. Click Subscribe or Start Free Trial (when available) to get your key.
3. Call endpoints with the header Authorization: Bearer YOUR_API_KEY.

Australia Realty API overview

The Australia Realty API exposes endpoints to:

• List properties with filters and sorting (Get Properties List).
• Fetch detailed information for a specific property (Get Property Details).
• Autocomplete locations to drive search UX (Autocomplete).

You’ll work against real Hub URLs on Zyla. Do not add undocumented parameters. When rendering images from listing results, you must specify the target size directly in the image URL path (e.g., 170x32, 160x30, 114x21, 1536x800).

Endpoint: Get Properties List

List properties with options and filters. Use this to search by locality, switch channel (e.g., sold), control sorting, and paginate.

• Method: GET
• URL: https://zylalabs.com/api/1476/australia-realty-api/1221/get-properties-list

Request parameters

• channel (string, required): sold
• searchLocation (string, required): Sunshine Coast, QLD
• searchLocationSubtext (string, required): Region
• type (string, required): region
• pageSize (string, optional): 50
• page (string, optional): 2
• sortType (string, optional): new-desc

Pagination note: If the page field returns a value of 50, that is the highest available page number for the current query.

Official cURL example

curl -s -X GET "https://zylalabs.com/api/1476/australia-realty-api/1221/get-properties-list?pageSize=50&channel=sold&searchLocation=Sunshine+Coast%2C+QLD&searchLocationSubtext=Region&type=region&page=2&sortType=new-desc" \
  -H "Authorization: Bearer YOUR_API_KEY"

Official JSON response

{
"prettyUrl": "/sold/in-sunshine+coast%2c+qld/list-2?activeSort=list-date",
"totalResultsCount": 162134,
"resolvedLocalities": [
{
"display": "Sunshine Coast, QLD",
"precision": "region",
"atlasId": "9280a900-d539-4e0c-9385-9590315c4cb5",
"state": "QLD"
}
],
"resolvedQuery": {
"localities": [
{
"locality": "Sunshine Coast",
"subdivision": "QLD",
"searchLocation": "Sunshine Coast, QLD"
}
],
"sortType": "new-desc",
"channel": "sold",
"pageSize": "30",
"page": "2",
"filters": {
"surroundingSuburbs": true
}
},
"tieredResults": [
{
"tier": 1,
"count": 30,
"results": [
{
"prettyUrl": "property-unit-qld-mudjimba-122053054",
"standard": true,
"midtier": false,
"lister": {
"mobilePhoneNumber": "0402972763",
"website": "http://www.bluemoonproperty.com.au",
"phoneNumber": "0402972763",
"powerProfile": false,
"jobTitle": "Sales Consultant",
"name": "Beatrice Borns",
"mainPhoto": {
"server": "https://i3.au.reastatic.net",
"name": "main photo",
"uri": "/ca783e0f628a14ff14b48ea8e53a7432f9c5b8f5676004cc2f8fecbfdc27ca95/main.jpg"
},
"id": "1405426",
"email": "[email protected]"
},
"featured": false,
"signature": false,
"constructionStatus": "established",
"channel": "sold",
"description": "Why pay a fortune for holidays when you can own your own piece of Resort-style living on the beautiful Sunshine Coast.<br/>Take use of the pool, 2 tennis courts, putting green, BBQ Area by the River and separate play ground for the children.<br/><br/>This 3 bedroom Townhouse is situated in the Pet Friendly gated and secure Resort just a short 2km from the beautiful Mudjimba Beach.<br/>The Resort is surrounded by a canal on two sides, ideal for fishing or boating,…

What to read from the response

• totalResultsCount: total matched listings across all pages, useful for pagination controls.
• resolvedLocalities and resolvedQuery: the server’s interpretation of your search (locality, channel, page, sort).
• tieredResults[0].count and tieredResults[0].results: the listings on the current page.
• Each result.lister contains agency contact info and mainPhoto. To request an image, include a supported size in the URL path. For example: server + "/1536x800" + uri.

Image sizing requirement: You must indicate the format (size) in the image URL. Supported examples include 170x32, 160x30, 114x21, 1536x800. For instance: https://i3.au.reastatic.net/1536x800/ca783e0....../main.jpg

Python example: fetch and parse a properties list

This snippet calls the exact endpoint above, prints the total results count, then iterates the first tier of results to extract a few practical fields.

import requests

API_KEY = "YOUR_API_KEY"
url = "https://zylalabs.com/api/1476/australia-realty-api/1221/get-properties-list"
params = {
"pageSize": "50",
"channel": "sold",
"searchLocation": "Sunshine Coast, QLD",
"searchLocationSubtext": "Region",
"type": "region",
"page": "2",
"sortType": "new-desc",
}
headers = {"Authorization": f"Bearer {API_KEY}"}

resp = requests.get(url, params=params, headers=headers, timeout=30)
resp.raise_for_status()
data = resp.json()

print("Total results:", data.get("totalResultsCount"))

tiers = data.get("tieredResults", [])
if tiers:
tier0 = tiers[0]
print("Listings on this page:", tier0.get("count"))
for item in tier0.get("results", []):
pretty = item.get("prettyUrl")
channel = item.get("channel")
lister = item.get("lister", {})
agent = lister.get("name")
main_photo = lister.get("mainPhoto", {})
server = main_photo.get("server")
uri = main_photo.get("uri")
# Construct a 1536x800 image URL as required by the API image format rule.
image_url = None
if server and uri:
image_url = f"{server}/1536x800{uri}"
print({
"prettyUrl": pretty,
"channel": channel,
"agent": agent,
"image": image_url
})

Practical integration notes

• Pagination: Use the page parameter to iterate. If the response’s page field indicates 50, that’s the highest page for the query.
• Sorting: sortType=new-desc returns newest first for the specified channel.
• Images: Always include an explicit size in the path. Store the server and uri, but build size-specific URLs when rendering.
• Caching: Cache searches by the full set of query parameters (including page) to avoid refetching unmodified pages during a session.

Endpoint: Get Property Details

When a user clicks a listing, request details for that specific property.

• Method: GET
• URL: https://zylalabs.com/api/1476/australia-realty-api/1222/get-property-details

Request parameters

• id (number, required): 444325280

cURL

Example response

{"totalResultsCount":1,"results":[{"prettyUrl":"property-unit-qld-east+brisbane-444325280","standard":false,"midtier":false,"lister":{"mobilePhoneNumber":"0415648373","website":"http://www.housemark.com.au","phoneNumber":"0415648373","powerProfile":false,"name":"Isabella Palinkas","mainPhoto":{"server":"https://i3.au.reastatic.net","name":"main photo","uri":"/10082ec1487f85957c4f7062944636ee7600a93bdaf34549cb5f2705c1250f13/main.jpg"},"id":"3706692","email":"[email protected]"},"featured":false,"signature":true,"channel":"rent","description":"Welcome to 4/8 Longlands Street, East Brisbane! Just moments from The Gabba and surrounded by an array of cafés, shops, transport options, and major amenities, this home is ideal for those seeking easy inner-city living.<br/><br/>Recently transformed with a complete interior refresh, this beautifully updated unit is ready for its new owners to enjoy. Featuring fresh paint throughout, a stunning brand-new kitchen, renovated bathroom and laundry, and new flooring throughout, every detail has been thoughtfully modernised. Combining comfort, functionality and modern appeal, this is an outstanding opportunity for those seeking…"}

As with list responses, build image URLs by inserting a supported size into the path: server + "/1536x800" + uri (or another supported size).

Endpoint: Autocomplete

Use this to power search inputs with suggested regions or suburbs. This endpoint requires that you specify a term to be autocompleted; no request parameters are documented here beyond that note. Send your Authorization header.

• Method: GET
• URL: https://zylalabs.com/api/1476/australia-realty-api/5339/autocomplete

cURL

Example response

{"_embedded":{"suggestions":[{"display":{"subtext":"Region","text":"Sydney CBD, NSW"},"id":"6102b706-7216-4cde-b780-45cba0514ac5","source":{"atlasId":"6102b706-7216-4cde-b780-45cba0514ac5","name":"Sydney CBD","state":"NSW"},"type":"region"},{"display":{"subtext":"Suburb","text":"Sydney, NSW 2000"},"id":"99b291a3-bfcf-4bf9-bbaa-bdb9d89abc24-2000","source":{"atlasId":"99b291a3-bfcf-4bf9-bbaa-bdb9d89abc24","name":"Sydney","postcode":"2000","state":"NSW"},"type":"suburb"},{"display":{"subtext":"Suburb","text":"Sydney Olympic Park, NSW 2127"},"id":"19174a2e-3f53-4be4-8477-443d47249f20-2127","source":{"atlasId":"19174a2e-3f53-4be4-8477-443d47249f20","name":"Sydney Olympic Park","postcode":"2127","state":"NSW"},"type":"suburb"},{"display":{"subtext":"Region","text":"Western Sydney, NSW"},"id":"637c2a12-9141-4e1d-adfa-30bd200a49a4","source":{"atlasId":"637c2a12-9141-4e1d-adfa-30bd200a49a4","name":"Western Sydney","state":"NSW"},"type":"region"},{"display":{"subtext":"Region","text":"South Western Sydney, NSW"},"id":"0eadb86e-6345-43b6-ab6d-18e17c779817","source":{"atlasId":"0eadb86e-6345-43b6-ab6d-18e17c779817","name":"South Western Sydney","state":"NSW"},"type":"region"},{"display":{"subt…

Real-world flows to ship quickly

Property search page (sold listings by region)

1. Autocomplete the user’s input to capture type=suburb or type=region and the display text.
2. Call Get Properties List with channel=sold, type and searchLocation exactly matching your chosen suggestion, and searchLocationSubtext set appropriately (e.g., Region).
3. Render tieredResults[0].results and a pager from totalResultsCount and page.
4. Build image URLs per item using mainPhoto.server + "/1536x800" + mainPhoto.uri.

Drill-down to a single property

1. From a result, navigate with prettyUrl in your app’s routing, and store/display basic info.
2. Call Get Property Details with id for deeper description and the lister’s contacts.
3. Reuse the image sizing rule for hero images and thumbnails.

Daily updates or alerts pipeline

• Schedule Get Properties List with sortType=new-desc for the target localities.
• Track the max observed prettyUrl or ID per locality to avoid duplicates.
• Send notifications with the lister’s name and a pre-sized image URL.

Calling the API from an AI agent (MCP)

If you prefer to orchestrate calls from an AI coding environment, Zyla exposes a Model Context Protocol endpoint that works with MCP-compatible clients. Configure your client to call the MCP endpoint and use your Zyla API key. See the docs here:

MCP

Any tool/agent using MCP can then perform the same HTTP requests shown above with the Authorization: Bearer header and the documented URLs and parameters.

Troubleshooting and integration tips

• Authorization: Always include Authorization: Bearer YOUR_API_KEY. Omit additional undocumented keys.
• Parameter fidelity: Use only the parameters documented for each endpoint. For example, channel, searchLocation, searchLocationSubtext, and type are required for the list example shown.
• Pagination ceiling: Stop paginating when the response indicates page 50 as the highest page for that query.
• Image rendering: If an image fails to load, confirm you inserted a supported size into the path before the uri.
• Quota: Usage follows subscription + quota, not pay-per-call. Monitor calls to stay within your current plan.

FAQ

How do I authenticate?
Send Authorization: Bearer YOUR_API_KEY with every request.

Which parameters are required to get a properties list?
channel, searchLocation, searchLocationSubtext, and type are required. pageSize, page, and sortType are optional.

What’s the maximum page I can request?
If the response’s page field returns 50, that is the highest pagination number available for that query.

How do I load listing images?
Use the lister.mainPhoto fields and insert a supported size into the path: server + "/1536x800" + uri (or one of the other documented sizes).

Is there a free plan?
No Free Plan. The first API typically offers a 7-day trial or 50 requests; check the API page for current access options and pricing.

Start 7-day trial on Australia Realty API to get your key and ship your integration using the endpoints above.

Official API response

{
    "prettyUrl": "/sold/in-sunshine+coast%2c+qld/list-2?activeSort=list-date",
    "totalResultsCount": 162134,
    "resolvedLocalities": [
        {
            "display": "Sunshine Coast, QLD",
            "precision": "region",
            "atlasId": "9280a900-d539-4e0c-9385-9590315c4cb5",
            "state": "QLD"
        }
    ],
    "resolvedQuery": {
        "localities": [
            {
                "locality": "Sunshine Coast",
                "subdivision": "QLD",
                "searchLocation": "Sunshine Coast, QLD"
            }
        ],
        "sortType": "new-desc",
        "channel": "sold",
        "pageSize": "30",
        "page": "2",
        "filters": {
            "surroundingSuburbs": true
        }
    },
    "tieredResults": [
        {
            "tier": 1,
            "count": 30,
            "results": [
                {
                    "prettyUrl": "property-unit-qld-mudjimba-122053054",
                    "standard": true,
                    "midtier": false,
                    "lister": {
                        "mobilePhoneNumber": "0402972763",
                        "website": "http://www.bluemoonproperty.com.au",
                        "phoneNumber": "0402972763",
                        "powerProfile": false,
                        "jobTitle": "Sales Consultant",
                        "name": "Beatrice Borns",
                        "mainPhoto": {
                            "server": "https://i3.au.reastatic.net",
                            "name": "main photo",
                            "uri": "/ca783e0f628a14ff14b48ea8e53a7432f9c5b8f5676004cc2f8fecbfdc27ca95/main.jpg"
                        },
                        "id": "1405426",
                        "email": "[email protected]"
                    },
                    "featured": false,
                    "signature": false,
                    "constructionStatus": "established",
                    "channel": "sold",
                    "description": "Why pay a fortune for holidays when you can own your own piece of Resort-style living on the beautiful Sunshine Coast.<br/>Take use of the pool, 2 tennis courts, putting green, BBQ Area by the River and separate play ground for the children.<br/><br/>This 3 bedroom Townhouse is situated in the Pet Friendly gated and secure Resort just a short 2km from the beautiful Mudjimba Beach.<br/>The Resort is surrounded by a canal on two sides, ideal for fishing or boating,…

Official API response

{
    "prettyUrl": "/sold/in-sunshine+coast%2c+qld/list-2?activeSort=list-date",
    "totalResultsCount": 162134,
    "resolvedLocalities": [
        {
            "display": "Sunshine Coast, QLD",
            "precision": "region",
            "atlasId": "9280a900-d539-4e0c-9385-9590315c4cb5",
            "state": "QLD"
        }
    ],
    "resolvedQuery": {
        "localities": [
            {
                "locality": "Sunshine Coast",
                "subdivision": "QLD",
                "searchLocation": "Sunshine Coast, QLD"
            }
        ],
        "sortType": "new-desc",
        "channel": "sold",
        "pageSize": "30",
        "page": "2",
        "filters": {
            "surroundingSuburbs": true
        }
    },
    "tieredResults": [
        {
            "tier": 1,
            "count": 30,
            "results": [
                {
                    "prettyUrl": "property-unit-qld-mudjimba-122053054",
                    "standard": true,
                    "midtier": false,
                    "lister": {
                        "mobilePhoneNumber": "0402972763",
                        "website": "http://www.bluemoonproperty.com.au",
                        "phoneNumber": "0402972763",
                        "powerProfile": false,
                        "jobTitle": "Sales Consultant",
                        "name": "Beatrice Borns",
                        "mainPhoto": {
                            "server": "https://i3.au.reastatic.net",
                            "name": "main photo",
                            "uri": "/ca783e0f628a14ff14b48ea8e53a7432f9c5b8f5676004cc2f8fecbfdc27ca95/main.jpg"
                        },
                        "id": "1405426",
                        "email": "[email protected]"
                    },
                    "featured": false,
                    "signature": false,
                    "constructionStatus": "established",
                    "channel": "sold",
                    "description": "Why pay a fortune for holidays when you can own your own piece of Resort-style living on the beautiful Sunshine Coast.<br/>Take use of the pool, 2 tennis courts, putting green, BBQ Area by the River and separate play ground for the children.<br/><br/>This 3 bedroom Townhouse is situated in the Pet Friendly gated and secure Resort just a short 2km from the beautiful Mudjimba Beach.<br/>The Resort is surrounded by a canal on two sides, ideal for fishing or boating,…