GET
For Sale Properties
http://127.0.0.1:2026/api/property/properties
Retrieves detailed information about properties currently listed for sale around 1.5km of the property, including property attributes, location details, and listing information.
Important: The id parameter refers to the property's GNAF ID.
You can retrieve this value from Get GNAF_ID (Geocoder) API Endpoint. Click to see documentation
You can retrieve this value from Get GNAF_ID (Geocoder) API Endpoint. Click to see documentation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
text | Required | Property identifier (GnafID) |
property_type |
text | Optional | Type of property (house, unit, all). Default is 'house' |
Response Schema
| Field | Type | Description |
|---|---|---|
results |
array | Array of property listings |
results[].address |
object | Detailed address information |
results[].address.sa1 |
string | Statistical Area Level 1 identifier |
results[].address.sal |
string | Suburb and Locality name |
results[].address.state |
string | State abbreviation (e.g., NSW) |
results[].address.street |
string | Street address |
results[].area_level |
string | Level of geographical detail (e.g., 'address') |
results[].area_name |
string | Full formatted address |
results[].attributes |
object | Property attributes and features |
results[].attributes.bathrooms |
number | Number of bathrooms |
results[].attributes.bedrooms |
number | Number of bedrooms |
results[].attributes.building_size |
string | Size of the building (may be null) |
results[].attributes.garage_spaces |
number | Number of garage spaces |
results[].attributes.land_size |
string | Size of the land |
results[].coordinates |
object | Geographical coordinates |
results[].coordinates.latitude |
number | Latitude coordinate |
results[].coordinates.longitude |
number | Longitude coordinate |
results[].gnaf_pid |
string | G-NAF Persistent Identifier (unique address ID) |
results[].listing_date |
string | Date when the property was listed for sale |
results[].price |
number | Listed price in dollars |
results[].property_type |
string | Type of property (e.g., 'house', 'unit') |
Request Examples
cURL
Python
JavaScript
curl -X GET "http://127.0.0.1:2026/api/property/properties?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"results": [
{
"address": {
"sa1": "11101120624",
"sal": "Belmont North",
"state": "NSW",
"street": "15 Rengor Close"
},
"area_level": "address",
"area_name": "15 Rengor Close, Belmont North, NSW",
"attributes": {
"bathrooms": 2,
"bedrooms": 4,
"building_size": null,
"description": "This beautifully designed four-bedroom, two-bathroom Hamptons-inspired home offers a perfect balance of style, comfort, and practicality. With high-end finishes and a well-thought-out floor plan, it's ideal for families or anyone looking for a modern, low-maintenance home in a sought-after location.",
"garage_spaces": 3,
"land_size": "507 m²"
},
"coordinates": {
"latitude": -33.01064264,
"longitude": 151.67045462
},
"gnaf_pid": "GANSW717662275",
"listing_date": "Fri, 21 Feb 2025 00:00:00 GMT",
"price": 1335000,
"property_type": "house"
}
]
}