Developer documentationAPI v1Download OpenAPI ↗

MARKET PULSE

Observed market summary

Counts of observed listings, grouped by status and property type; not a census of the Australian property market.

GET/api/v1/market/summary5 credits / call
Bearer authentication requiredJSON responseAccount-wide rate limits

Parameters

ParameterTypeDescription
statestringAustralian state or territory code.ACT, NSW, NT, QLD, SA, TAS, VIC, WA
postcodestringExact four-digit postcode.
property_typestringNormalised public property type.house, apartment, unit, townhouse, villa, land, rural, commercial, other
agency_idintegerAgency identifier from the agency endpoint.
updated_sincestringUTC ISO 8601 timestamp; at most 90 days ago.

MAKE IT YOUR OWN

Build a request

5 credits per call

Edit the parameters to generate a ready-to-use code example. No request runs until you select Send request. Python uses the requests package; PHP requires cURL; JavaScript examples run on your backend with Node.js 18 or later.

GET
This request may consume 5 credits. Normal limits apply.

Example response

Illustrative structure, not a live property record. Fields may be null when the source has not supplied a value.

application/json
{
    "data": {
        "observed_listings": 1250,
        "by_status": [
            {
                "value": "active",
                "count": 900
            }
        ],
        "by_property_type": [
            {
                "value": "house",
                "count": 650
            }
        ]
    },
    "meta": {
        "example": true,
        "credit_cost": 5
    }
}

Also available through MCP

Use the listingdata_market_summary tool with the same documented inputs. Calls share your REST API credit balance and rate limits. Connect your MCP client →

Errors and retrying

StatusMeaningRecommended handling
400 / 422Invalid or unsupported parameters.Correct the input using the error response.
401 / 403Invalid key or ineligible account.Check key status and account verification.
404The requested record is not available.Check the ID; do not infer a property’s status.
402Monthly credit allowance exhausted.Wait for the next UTC calendar month.
429Minimum interval or daily request allowance exceeded.Honour Retry-After and reset details.
503A required data service is unavailable.Back off and retry later. Service-side charges are refunded.
A deliberate public view

Property descriptions, internal search price bands and agent contact email or telephone numbers are never included. Source status and timestamps describe observations, not a guarantee of current availability. Future-dated source times are withheld. A record’s indexed_at is its last public index write; use the coverage endpoint for the last completed refresh cycle. Read the field policy.