Overview
The PropertyData API provides programmatic access to Australian property and address data. All endpoints return JSON and follow standard HTTP conventions.
Authentication
All requests must include your API key in the X-API-KEY header.
GET /api/v1/property/geocode?gnaf_id=GAACT717940975 X-API-KEY: your_api_key_here
import requests
headers = {"X-API-KEY": "your_api_key_here"}
r = requests.get(
"https://api.propertydataservices.com.au/api/v1/property/geocode",
params={"gnaf_id": "GAACT717940975"},
headers=headers,
)
print(r.json())
curl -H "X-API-KEY: your_api_key_here" \ "https://api.propertydataservices.com.au/api/v1/property/geocode?gnaf_id=GAACT717940975"
Base URL
https://api.propertydataservices.com.au/api/v1/property
All endpoint paths below are relative to this base URL.
Errors
| Status | Meaning |
|---|---|
400 | Bad request — missing or invalid parameter |
401 | Unauthorised — invalid or missing API key |
404 | Resource not found (e.g. unknown G-NAF ID) |
422 | Validation error — check parameter types |
502 | Upstream API error (Geoscape, Gemini, etc.) |
Error responses include a detail field describing the problem:
{"detail": "G-NAF address not found: GAACT000000000"}
Returns address autocomplete suggestions for a partial query string. Backed by the Geoscape Predictive API.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Partial address query (min 3 chars) |
Response
[
{
"gnaf_id": "GAACT717940975",
"display_name": "1 Main Street, Sydney NSW 2000"
},
...
]
Example
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/address-suggest?q=1+Martin+Pl"
Resolves a G-NAF address ID to coordinates, suburb, postcode, and state. Use the gnaf_id returned from /address-suggest.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
gnaf_id | string | Yes | G-NAF address ID (e.g. GAACT717940975) |
Response
{
"gnaf_id": "GAACT717940975",
"display_name": "1 Martin Place, Sydney NSW 2000",
"suburb": "Sydney",
"postcode": "2000",
"state": "NSW",
"lat": -33.86785,
"lon": 151.20732
}
Returns property statistics for a geocoded address, including median price where available.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
lat | float | Yes | Latitude from geocode |
lon | float | Yes | Longitude from geocode |
address | string | Yes | Resolved display address |
suburb | string | No | Suburb name |
postcode | string | No | Postcode |
state | string | No | State/territory abbreviation |
Response
{
"address": "1 Martin Place, Sydney NSW 2000",
"suburb": "Sydney",
"postcode": "2000",
"state": "NSW",
"lat": -33.86785,
"lon": 151.20732,
"median_price": 1500000.0
}
Returns an AI-generated suburb and property overview powered by Google Gemini 2.5 Flash. Covers demographics, market conditions, amenities, transport, and lifestyle.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
lat | float | Yes | Latitude from geocode |
lon | float | Yes | Longitude from geocode |
address | string | Yes | Resolved display address |
Response
{
"address": "1 Martin Place, Sydney NSW 2000",
"summary": "## Suburb Overview\nSydney CBD is located in the heart of..."
}
Returns nearby public transport stops (train, tram, bus, ferry) within a given radius. Sourced from OpenStreetMap via Overpass API.
Query Parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lat | float | Yes | — | Latitude |
lon | float | Yes | — | Longitude |
address | string | Yes | — | Display address |
radius_m | int | No | 1000 | Search radius in metres (100–5000) |
Response
{
"address": "1 Martin Place, Sydney NSW 2000",
"centre_lat": -33.86785,
"centre_lon": 151.20732,
"radius_m": 1000,
"stops": [
{
"name": "Martin Place Station",
"type": "train_station",
"distance_km": 0.05,
"lat": -33.8679,
"lon": 151.2077
},
...
]
}
Stop types
train_station · train_halt · tram_stop · bus_stop · ferry_terminal · transit_stop
Returns nearby schools within a given radius. Sourced from ACARA (Australian Curriculum, Assessment and Reporting Authority) school location data.
Query Parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lat | float | Yes | — | Latitude |
lon | float | Yes | — | Longitude |
address | string | Yes | — | Display address |
radius_m | int | No | 2000 | Search radius in metres (100–10000) |
Response
{
"address": "1 Martin Place, Sydney NSW 2000",
"centre_lat": -33.86785,
"centre_lon": 151.20732,
"radius_m": 2000,
"schools": [
{
"name": "Sydney Grammar School",
"type": "Primary",
"distance_km": 0.42,
"lat": -33.8712,
"lon": 151.2134
},
...
]
}
School types
Primary · Secondary · Combined
Returns development applications (DAs) lodged near a given address, sourced from the Planning Alerts API. Results are sorted by distance.
Query Parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lat | float | Yes | — | Latitude |
lon | float | Yes | — | Longitude |
address | string | Yes | — | Display address |
radius_m | int | No | 1000 | Search radius in metres (100–5000) |
Response
{
"address": "1 Martin Place, Sydney NSW 2000",
"centre_lat": -33.86785,
"centre_lon": 151.20732,
"radius_m": 1000,
"applications": [
{
"id": 123456,
"council_reference": "DA/2024/0041",
"address": "2 Martin Place Sydney NSW 2000",
"description": "Alterations and additions to existing commercial building",
"info_url": "https://...",
"date_received": "2024-03-01",
"on_notice_to": "2024-03-22",
"authority": "City of Sydney Council",
"distance_km": 0.08
},
...
]
}
Returns cadastral title information for a G-NAF address ID, including lot/plan identifiers and the state land registry reference.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
gnaf_id | string | Yes | G-NAF address ID |
Response
{
"gnaf_id": "GAACT717940975",
"address": "1 Martin Place, Sydney NSW 2000",
"cadastral_identifier": "SYDN/SYDN/1/A",
"address_record_type": "PRIMARY",
"suburb": "Sydney",
"postcode": "2000",
"state": "NSW",
"lat": -33.86785,
"lon": 151.20732
}
Returns cadastre parcel data for a coordinate pair from the NSW Spatial Services. Returns null if no parcel is found or the address is outside NSW.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
lat | float | Yes | Latitude |
lon | float | Yes | Longitude |
Response
{
"cadid": 2123456,
"lot_number": "1",
"plan_label": "DP123456",
"lot_id_string": "1//DP123456",
"area_sqm": 412.5,
"title_status": "Titled",
"stratum_level": null,
"has_stratum": false
}
Returns bushfire risk assessment for a coordinate pair, sourced from the NSW ePlanning Portal hazard layer.
"Low Risk" when no hazard layer intersects the point.Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
lat | float | Yes | Latitude |
lon | float | Yes | Longitude |
Response
{
"lat": -33.86785,
"lon": 151.20732,
"risk": "Low Risk",
"category": null,
"category_label": null,
"guideline": null,
"last_update": null
}
{
"lat": -33.5,
"lon": 150.9,
"risk": "WARNING",
"category": 1,
"category_label": "Vegetation Category 1 – Highest risk (forest, woodland, heath, wetland)",
"guideline": "BAL-FZ",
"last_update": "12 Jan 2024"
}
Category values
| Category | Label |
|---|---|
0 | Vegetation Buffer (100 m around Cat 1, 30 m around Cat 2/3) |
1 | Vegetation Category 1 – Highest risk |
2 | Vegetation Category 2 – Moderate risk |
3 | Vegetation Category 3 – Lower risk |
Example
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/bushfire-risk?lat=-33.5&lon=150.9"
Returns a summary of rental bond lodgements for a postcode, grouped by dwelling type and bedroom count. Data is sourced from the PropertyData RDS database.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
postcode | string | Yes | 4-digit Australian postcode |
Response
{
"postcode": "2000",
"results": [
{
"dwellingtypedesc": "Apartment",
"bedrooms": "1",
"total_count": 342,
"avg_weeklyrent": 620.50
},
{
"dwellingtypedesc": "Apartment",
"bedrooms": "2",
"total_count": 215,
"avg_weeklyrent": 890.00
},
...
]
}
Example
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/rental-bond-summary?postcode=2000"
Returns the land area (in square metres) for a cadastral lot/plan identifier. Sourced from NSW Spatial Services.
lot_id_string from /cadastre to obtain the lot and plan values.Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
cadastre | string | Conditional | Lot/plan in lot/plan format (e.g. 1/848172). Use this or lot + plan. |
lot | string | Conditional | Lot number (e.g. 10) |
plan | string | Conditional | Plan number with optional prefix (e.g. DP246488 or 246488) |
Response
{
"lot_number": "1",
"plan_number": 848172,
"plan_label": "DP848172",
"area_sqm": 650.75
}
Example
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/landsize?cadastre=1/848172"
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/landsize?lot=1&plan=DP848172"
Returns property sales records for a postcode within a date range. Data is sourced from the PropertyData RDS database and sorted by contract date descending.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
postcode | integer | Yes | Australian postcode |
date_from | integer | Yes | Start date inclusive in YYYYMMDD format (e.g. 20240101) |
date_to | integer | Yes | End date inclusive in YYYYMMDD format (e.g. 20241231) |
Response
{
"postcode": 2000,
"date_from": 20240101,
"date_to": 20241231,
"total": 2,
"sales": [
{
"property_id": 10023456,
"lga_code": 10500,
"street_number": "12",
"street": "PITT ST",
"suburb": "SYDNEY",
"postcode": 2000,
"area": 210.0,
"area_type": "M",
"contract_date": "2024-11-05",
"settlement_date": "2024-12-20",
"purchase_price": 1250000,
"property_type_code": "R",
"property_type_category": "Residential",
"property_type_desc": "House",
"lot_plan": "1//DP123456",
"valuation_id": "1234567"
},
...
]
}
Example
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/sales-data?postcode=2000&date_from=20240101&date_to=20241231"
Returns an interactive HTML map centred on a property parcel, rendered with Leaflet and NSW Cadastre data. The response is an text/html page suitable for embedding in an <iframe>.
Query Parameters
Provide either coordinates or a lot/plan identifier:
| Param | Type | Required | Description |
|---|---|---|---|
lat | float | Conditional | Latitude (use with lon) |
lon | float | Conditional | Longitude (use with lat) |
cadastre | string | Conditional | Lot/plan shorthand (e.g. 1/848172) |
lot | string | Conditional | Lot number (e.g. 10) |
plan | string | Conditional | Plan number (e.g. DP848172) |
Example
<iframe src="https://api.propertydataservices.com.au/api/v1/property/property-map?lat=-33.86785&lon=151.20732" width="100%" height="400" frameborder="0"> </iframe>
curl -H "X-API-KEY: your_key" \ "https://api.propertydataservices.com.au/api/v1/property/property-map?cadastre=1/848172"
Typical Workflow
Most integrations follow this three-step pattern:
import requests
BASE = "https://api.propertydataservices.com.au/api/v1/property"
H = {"X-API-KEY": "your_api_key_here"}
# 1. Suggest
suggestions = requests.get(f"{BASE}/address-suggest", params={"q": "1 Martin Pl"}, headers=H).json()
gnaf_id = suggestions[0]["gnaf_id"]
# 2. Geocode
geo = requests.get(f"{BASE}/geocode", params={"gnaf_id": gnaf_id}, headers=H).json()
lat, lon, address = geo["lat"], geo["lon"], geo["display_name"]
# 3. Parallel lookups (shown sequentially for clarity)
property_data = requests.get(f"{BASE}/lookup",
params={"lat": lat, "lon": lon, "address": address,
"suburb": geo["suburb"], "postcode": geo["postcode"], "state": geo["state"]},
headers=H).json()
transport = requests.get(f"{BASE}/nearest-transport",
params={"lat": lat, "lon": lon, "address": address, "radius_m": 1000},
headers=H).json()
print(property_data)
print(f"{len(transport['stops'])} transport stops found")
Rate Limits
| Plan | Requests / minute | Requests / day |
|---|---|---|
| Free (sandbox) | 10 | 100 |
| Starter | 60 | 5,000 |
| Pro | 300 | 50,000 |
| Enterprise | Custom | Custom |
Rate limit headers are included in every response:
X-RateLimit-Limit: 60 X-RateLimit-Remaining: 58 X-RateLimit-Reset: 1710000060
Support
For API access requests, billing, or technical issues:
- Email: api@propertydataservices.com.au
- Docs feedback: open an issue on GitHub