Introduction
Welcome to the Property Data API! You can use our API to access Property API endpoints, which can get information on various properties, suburbs, and reports.
Get Started
These steps will get you up-and-running with the Property Data API.!
Creating an account
The first thing you'll want to do is create an account
What's next?
Once you created an account, you can login and create an API Key. You can use API Key to Get Token which is using to access Property Data API
Authentication
Get Token
curl -X POST "/api/auth"
-F email=my_email
-F api_key=my_api_keyMake sure to replace
my_emailwith your Email, replacemy_api_keyto your api_key.
Succss Response: HTTP/1.1 201 Created
{
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbHVtZd4tYXBpLWRlbW8uZGV1L2FwaS9hdXRob3JpemF0aW9ucyIsImlhdCI6MTQ4Mzk3NTY5MywiZXhwIjoxNDg5MTU5NjkzLCJuYmYiOjE0ODM5NzU2OTMsImp0aSI6ImViNzAwZDM1MGIxNzM5Y2E5ZjhhNDk4NGMzODcxMWZjIiwic3ViIjo1M30.hdny6T031vVmyWlmnd2aUr4IVM9rm2Wchxg5RX_SDpM",
"expired_at": "2017-03-10 15:28:13",
"refresh_expired_at": "2017-01-23 15:28:13"
}
}Error Response: HTTP/1.1 404 Not Found
{
"error": "UserNotFound"
}This endpoint retrieves token by using email and api_key. You can get api_key from here
HTTP Request
POST /api/auth
Parameters
| Field | Type | Description |
|---|---|---|
| api_key | String | API Key |
Authorization: Bearer TOKEN
Get Token By Password
curl -X POST "/api/authorizations"
-F email=myemail
-F password=mypasswordMake sure to replace
myemailwith your Email, replacemypasswordto your password.
Succss Response: HTTP/1.1 201 Created
{
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbHVtZd4tYXBpLWRlbW8uZGV1L2FwaS9hdXRob3JpemF0aW9ucyIsImlhdCI6MTQ4Mzk3NTY5MywiZXhwIjoxNDg5MTU5NjkzLCJuYmYiOjE0ODM5NzU2OTMsImp0aSI6ImViNzAwZDM1MGIxNzM5Y2E5ZjhhNDk4NGMzODcxMWZjIiwic3ViIjo1M30.hdny6T031vVmyWlmnd2aUr4IVM9rm2Wchxg5RX_SDpM",
"expired_at": "2017-03-10 15:28:13",
"refresh_expired_at": "2017-01-23 15:28:13"
}
}Error Response: HTTP/1.1 404 Not Found
{
"error": "UserNotFound"
}This endpoint retrieves token.
HTTP Request
POST /api/authorizations
Parameters
| Field | Type | Description |
|---|---|---|
| password | String | password |
Authorization: Bearer TOKEN
Delete current token
curl -X DELETE "/api/authorizations/current"
-H "Authorization: Bearer TOKEN"Make sure to replace
TOKEN
Succss Response: HTTP/1.1 204 No Content
This endpoint delete the current token.
HTTP Request
DELETE /api/authorizations/current
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Refresh token
curl -X PUT "/api/authorizations/current"
-H "Authorization: Bearer TOKEN"Make sure to replace
TOKEN
Succss Response: HTTP/1.1 200 OK
{
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbHdtZd4tYXBpLWRlbW8uZGV1L2FwaS9hdXRob3JpemF0aW9ucyIsImlhdCI6MTQ4Mzk3NTY5MywiZXhwIjoxNDg5MTU5NjkzLCJuYmYiOjE0ODM5NzU2OTMsImp0aSI6ImViNzAwZDM1MGIxNzM5Y2E5ZjhhNDk4NGMzODcxMWZjIiwic3ViIjo1M30.hdny6T031vVmyWlmnd2aUr4IVM9rm2Wchxg5RX_SDpM",
"expired_at": "2017-03-10 15:28:13",
"refresh_expired_at": "2017-01-23 15:28:13"
}
}This endpoint refresh the current token.
HTTP Request
PUT /api/authorizations/current
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
My
Change Password
curl -X PUT "/api/my/password"
-F old_password=oldpassword
-F password=newpassword
-F password_confirmation=newpasswordMake sure to replace
oldpasswordwith your old password, replacemypasswordto your new password.
Succss Response: HTTP/1.1 204 No Content
Error Response: HTTP/1.1 400 Bad Request
{
"password": [
"new password does not match the confirm password",
"the new password must not be same as old password"
],
"password_confirmation": [
"new password does not match the confirm password"
],
"old_password": [
"password is wrong"
]
}This endpoint change password.
HTTP Request
PUT /api/my/password
Parameters
| Field | Type | Description |
|---|---|---|
| old_password | String | old password |
| password | String | password |
| password_confirmation | String | confirm password |
Authorization: Bearer TOKEN
Current user info
curl "/api/my"
-H "Authorization: Bearer TOKEN"Make sure to replace
TOKEN
Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 123,
"email": "youremail@gmail.com",
"name": "foobar",
"created_at": "2018-09-08 09:13:57",
"updated_at": "2018-09-08 09:13:57",
"deleted_at": null
}
}This endpoint get the current user info.
HTTP Request
GET /api/my
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
State
Auction Summary
curl "/api/state/vic/auction-summary?date=2018-09-15"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"num_of_week": 37,
"state": "VIC",
"auction_date": "2018-09-15",
"clearance_rate": 60.4,
"reported": 939,
"sold_before_auction": 190,
"sold_at_auction": 369,
"sold_after_auction": 8,
"withdrawn": 19,
"passed_in": 353,
"sold": 567,
"unsold": 372,
"sum_price": 396596706,
"median_price": 770000,
"updated_at": "2018-09-16"
}
}This endpoint retrieves state auction results summary.
HTTP Request
GET /api/state/{state}/auction-summary
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| date | Date | Latest auction date | Optional, Saturday auction date in format yyyy-mm-dd, must after 2017-01-01 |
| include | String | Optional, Allowed values: last_week, last_year, suburb_count, top_sales |
Auction Results
curl "/api/state/vic/auction-results?date=2018-09-15"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"week": 37,
"state": "VIC",
"auction_date": "2018-09-15",
"clearance_rate": 60.4,
"reported": 939,
"sold_before_auction": 190,
"sold_at_auction": 369,
"sold_after_auction": 8,
"withdrawn": 19,
"passed_in": 353,
"sold": 567,
"unsold": 372,
"sum_price": 396596706,
"median_price": 770000,
"updated_at": "2018-09-16",
"results": {
"data": [
{
"address": "22 Clifton St",
"state": "VIC",
"suburb_name": "Aberfeldie",
"postcode": "3040",
"type": "house",
"bed": 3,
"sold_date": "2018-09-15",
"price": 1400000,
"result": "Sold",
"is_sold": true,
"pu_id": 49719523064,
"agency": "Barry Plant"
},
//more data here
]
}
}
}This endpoint retrieves state auction results.
HTTP Request
GET /api/state/{state}/auction-results
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| date | Date | Latest auction date | Optional, Saturday auction date in format yyyy-mm-dd, must after 2017-01-01 |
| limit | Integer | 10 | Optional, Allowed values: between 1 and 50 |
Top Suburbs By Sale Price
curl "/api/state/vic/top-suburbs-by-sale-price"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"state": "VIC",
"name": "Toorak",
"postcode": "3142",
"suburb_code": "toorak-vic-3142",
"suburb_name": "Toorak VIC 3142",
"median_price": 5050000
}
],
"meta": {
"property_type": "house",
"date_type": "month"
}
}This endpoint retrieves state top suburbs by sale price.
HTTP Request
GET /api/state/{state}/top-suburbs-by-sale-price
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
Top Suburbs By Sale Growth
curl "/api/state/vic/top-suburbs-by-sale-growth?date_type=5y"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"state": "VIC",
"name": "Raywood",
"postcode": "3570",
"suburb_code": "raywood-vic-3570",
"suburb_name": "Raywood VIC 3570",
"annual_growth": "1.0234"
}
],
"meta": {
"property_type": "house",
"date_type": "5y"
}
}This endpoint retrieves state top suburbs by sale growth rate.
HTTP Request
GET /api/state/{state}/top-suburbs-by-sale-growth
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
Top Suburbs By Rent Price
curl "/api/state/vic/top-suburbs-by-rent-price"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"state": "VIC",
"name": "Toorak",
"postcode": "3142",
"suburb_code": "toorak-vic-3142",
"suburb_name": "Toorak VIC 3142",
"median_price": 1200
}
],
"meta": {
"property_type": "house",
"date_type": "month"
}
}This endpoint retrieves state top suburbs by rent price.
HTTP Request
GET /api/state/{state}/top-suburbs-by-rent-price
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
Top Suburbs By Rent Growth
curl "/api/state/vic/top-suburbs-by-rent-growth?date_type=5y"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"state": "VIC",
"name": "Moolap",
"postcode": "3224",
"suburb_code": "moolap-vic-3224",
"suburb_name": "Moolap VIC 3224",
"annual_growth": "0.3328"
}
],
"meta": {
"property_type": "house",
"date_type": "5y"
}
}This endpoint retrieves state top suburbs by rent growth rate.
HTTP Request
GET /api/state/{state}/top-suburbs-by-rent-growth
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
Top Suburbs By Country of Birth
curl "/api/state/vic/top-suburbs-by-country-of-birth?country=china"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"state_code": "VIC",
"persons": 3660,
"total_persons": 11395,
"percentage": "0.3212",
"suburb_id": 2791,
"suburb_name": "Box Hill",
"suburb_code": "box-hill-vic-3128",
"postcode": "3128"
},
{
"state_code": "VIC",
"persons": 5355,
"total_persons": 19358,
"percentage": "0.2766",
"suburb_id": 1809,
"suburb_name": "Clayton",
"suburb_code": "clayton-vic-3168",
"postcode": "3168"
},
...
]This endpoint retrieves state top suburbs by country of birth.
HTTP Request
GET /api/state/{state}/top-suburbs-by-country-of-birth
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| country | String | Required, Allowed values: australia,bangladesh,cambodia,canada,chile,china(mainland + hong_kong + taiwan),china_mainland,china_hong_kong,china_taiwan,croatia,egypt,england,fiji,france,germany,greece,india,indonesia,iran,iraq,ireland,italy,japan,korea_south,lebanon,malaysia,malta,mauritius,myanmar,nepal,netherlands,new_zealand,pakistan,philippines,poland,scotland,singapore,south_africa,sri_lanka,thailand,turkey,usa,vietnam,wales,zimbabwe |
|
| order | String | percentage |
Optional, Allowed values: percentage, persons |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
Top Suburbs By Language Spoken At Home
curl "/api/state/vic/top-suburbs-by-language-spoken-at-home?language=chinese"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"state_code": "VIC",
"persons": 4611,
"total_persons": 11395,
"percentage": "0.4047",
"suburb_id": 2791,
"suburb_name": "Box Hill",
"suburb_code": "box-hill-vic-3128",
"postcode": "3128"
},
{
"state_code": "VIC",
"persons": 6468,
"total_persons": 19358,
"percentage": "0.3341",
"suburb_id": 1809,
"suburb_name": "Clayton",
"suburb_code": "clayton-vic-3168",
"postcode": "3168"
},
...
]This endpoint retrieves state top suburbs by given language.
HTTP Request
GET /api/state/{state}/top-suburbs-by-language-spoken-at-home
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| language | String | Required, Allowed values: english,afrikaans,arabic,aindlng,chinese,croatian,dutch,french,german,greek,indo_aryan,italian,japanese,korean,macedonian,maltese,polish,russian,samoan,serbian,southeast_asian_austronesian,spanish,tamil,thai,turkish,vietnamese |
|
| order | String | percentage |
Optional, Allowed values: percentage, persons |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 100 |
State For Sale Properties
curl "/api/state/vic/buy"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state_code": "VIC",
"buy": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for sale by state.
HTTP Request
GET /api/state/{state}/buy
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
State For Lease Properties
curl "/api/state/vic/for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state_code": "VIC",
"for_lease": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for lease by state.
HTTP Request
GET /api/state/{state}/for-lease
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| sort | String | date_desc |
Optional, Allowed values: price_desc, price_asc, date_desc |
| type | String | Property Type | Optional: house,unit,townhouse,apartment,studio |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 7, -1 means all |
| bath | Integer | Property Bathrooms | Optional, Allowed values: between -1 and 7, -1 means all |
| car | Integer | Property Car Spaces | Optional, Allowed values: between -1 and 7, -1 means all |
| price_high | Integer | 0 |
Optional |
| price_low | Integer | 0 |
Optional |
| address | String | Address | Optional, not include suburb name and postcode, only street number, street name and street type |
| postcode | String | Postcode | Optional, four digit postcode |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 50 |
State Sold Properties
curl "/api/state/vic/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state_code": "VIC",
"sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties sold within last 12 months by state.
HTTP Request
GET /api/state/{state}/sold
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
State Rent Properties
curl "/api/state/vic/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state_code": "VIC",
"rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as leased by state.
HTTP Request
GET /api/state/{state}/rent
| Field | Type | Description |
|---|---|---|
| state | String | Required, Allowed values: vic, nsw, qld, sa, wa, act, nt, tas |
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
SA2
SA2 Search
curl "/api/sa2/search?q=Keilor+East"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 2,
"gcc_name": "Greater Melbourne"
}
]Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "q",
"code": "The q field is required."
}
],
"status_code": 422
}This endpoint search for sa2 area by sa2 area name.
HTTP Request
GET /api/sa2/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | Required, search sa2 area name |
| limit | Integer | Optional, Allowed values: between 1 and 50 |
SA2 Info
curl "/api/sa2/210011229"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves SA2 detail.
HTTP Request
GET /api/sa2/{sa2_code}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: summary |
SA2 Sold Properties
curl "/api/sa2/210011229/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "210011229",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties sold within last 30 days in the sa2 area.
HTTP Request
GET /api/sa2/{sa2_code}/sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
SA2 Rent Properties
curl "/api/sa2/210011229/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "210011229",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"rent_date": "2018-08-18",
"rent_price": 500,
"pu_id": 29738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties rent within last 30 days in the sa2 area.
HTTP Request
GET /api/sa2/{sa2_code}/rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
SA2 Sold Trend Data
curl "/api/sa2/210011229/sold-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"sold_trend_data": {
"data": {
"investor_metrics": {
"median_price": 802500,
"median_price_12_months_ago": 820000,
"annual_growth_last_12_months": -0.0213
},
"invested_performance": {
"2017-08": 100,
"2017-09": 102.18
},
"trend_list": {
"2017-08": {
"price_avg": 780255,
"price_median": 802500,
"standard_deviation": 236961,
"price_min": 38350,
"price_10th": 500000,
"price_20th": 610000,
"price_25th": 640000,
"price_30th": 694000,
"price_40th": 750000,
"price_50th": 802500,
"price_60th": 835000,
"price_70th": 860000,
"price_75th": 875500,
"price_80th": 920000,
"price_90th": 1085000,
"price_max": 1680000,
"num_all": 265,
"num_all_with_price": 214,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 797468,
"price_median": 820000,
"standard_deviation": 234821,
"price_min": 38350,
"price_10th": 470000,
"price_20th": 625000,
"price_25th": 690000,
"price_30th": 720000,
"price_40th": 773000,
"price_50th": 820000,
"price_60th": 850000,
"price_70th": 872000,
"price_75th": 890000,
"price_80th": 934000,
"price_90th": 1085000,
"price_max": 1680000,
"num_all": 237,
"num_all_with_price": 193,
"start_date": "2016-10-01",
"end_date": "2017-09-30",
"growth": 0.0218
}
},
"filter": {
"sa2_id": 816
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and sold trend data.
HTTP Request
GET /api/sa2/{sa2_code}/sold-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
SA2 Rent Trend Data
curl "/api/sa2/210011229/rent-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"rent_trend_data": {
"data": {
"investor_metrics": {
"median_price": 400,
"median_price_12_months_ago": 390,
"annual_growth_last_12_months": 0.0256
},
"invested_performance": {
"2017-08": 100,
"2017-09": 100
},
"trend_list": {
"2017-08": {
"price_avg": 409,
"price_median": 390,
"standard_deviation": 192,
"price_min": 180,
"price_10th": 285,
"price_20th": 325,
"price_25th": 340,
"price_30th": 350,
"price_40th": 375,
"price_50th": 390,
"price_60th": 400,
"price_70th": 420,
"price_75th": 440,
"price_80th": 450,
"price_90th": 500,
"price_max": 2607,
"num_all": 341,
"num_all_with_price": 338,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 403,
"price_median": 390,
"standard_deviation": 143,
"price_min": 180,
"price_10th": 300,
"price_20th": 330,
"price_25th": 340,
"price_30th": 350,
"price_40th": 375,
"price_50th": 390,
"price_60th": 400,
"price_70th": 420,
"price_75th": 445,
"price_80th": 450,
"price_90th": 500,
"price_max": 2308,
"num_all": 360,
"num_all_with_price": 355,
"start_date": "2016-10-01",
"end_date": "2017-09-30",
"growth": 0
}
},
"filter": {
"sa2_id": 816
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and rent trend data.
HTTP Request
GET /api/sa2/{sa2_code}/rent-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
SA2 Sale-O-Meter
curl "/api/sa2/210011229/saleometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"saleometer": {
"data": {
"price_avg": 803336,
"price_median": 802000,
"standard_deviation": 207559,
"price_min": 200000,
"price_10th": 550000,
"price_20th": 630000,
"price_25th": 681100,
"price_30th": 710500,
"price_40th": 760000,
"price_50th": 802000,
"price_60th": 838000,
"price_70th": 910000,
"price_75th": 935000,
"price_80th": 970000,
"price_90th": 1066000,
"price_max": 1400000,
"num_all": 185,
"num_all_with_price": 160,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"sa2_id": 816
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and sale-o-meter.
HTTP Request
GET /api/sa2/{sa2_code}/saleometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
SA2 Rent-O-Meter
curl "/api/sa2/210011229/rentometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"rentometer": {
"data": {
"price_avg": 423,
"price_median": 400,
"standard_deviation": 93,
"price_min": 190,
"price_10th": 330,
"price_20th": 350,
"price_25th": 360,
"price_30th": 375,
"price_40th": 395,
"price_50th": 400,
"price_60th": 420,
"price_70th": 450,
"price_75th": 450,
"price_80th": 485,
"price_90th": 530,
"price_max": 900,
"num_all": 339,
"num_all_with_price": 334,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"sa2_id": 816
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and rent-o-meter.
HTTP Request
GET /api/sa2/{sa2_code}/rentometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
SA2 Sale Stats
curl "/api/sa2/210011229/sale-stats"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"sale_stats": {
"data": {
"property_type": "house",
"address_count": 9243,
"median_bed_count": 3,
"median_bath_count": 2,
"median_car_count": 2,
"for_sale_new_volume_1m": 19,
"for_sale_new_volume_3m": 31,
"for_sale_new_volume_6m": 54,
"for_sale_new_volume_12m": 78,
"for_sale_active_volume_1m": 49,
"for_sale_active_volume_3m": 54,
"for_sale_active_volume_6m": 68,
"for_sale_active_volume_12m": 84,
"for_sale_dom_median_12m": 30,
"for_sale_discount_median_12m": 9,
"sale_volume_12m": 321,
"sale_turnover_12m": 3.5,
"sale_sum_12m": 255291030,
"sale_minimum_12m": 200000,
"sale_maximum_12m": 1800000,
"sale_median_12m": 866000,
"sale_percentile_25_12m": 775000,
"sale_percentile_75_12m": 1010000,
"sale_median_1_bed_12m": 850000,
"sale_median_2_bed_12m": 681100,
"sale_median_3_bed_12m": 850000,
"sale_median_4_bed_12m": 935000,
"date": "2018-09-01",
"updated": "2018-11-01"
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and sale market trend.
HTTP Request
GET /api/sa2/{sa2_code}/sale-stats
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
SA2 Rent Stats
curl "/api/sa2/210011229/rent-stats"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"rent_stats": {
"data": {
"property_type": "house",
"address_count": 9243,
"median_bed_count": 3,
"median_bath_count": 2,
"median_car_count": 2,
"for_lease_new_volume_1m": 24,
"for_lease_new_volume_3m": 71,
"for_lease_new_volume_6m": 170,
"for_lease_new_volume_12m": 342,
"for_lease_active_volume_1m": 64,
"for_lease_active_volume_3m": 113,
"for_lease_active_volume_6m": 204,
"for_lease_active_volume_12m": 363,
"for_lease_dom_median_12m": 22,
"for_lease_discount_median_12m": 0,
"lease_volume_12m": 432,
"lease_turnover_12m": 4.7,
"lease_sum_12m": 189247,
"lease_minimum_12m": 260,
"lease_maximum_12m": 962,
"lease_median_12m": 420,
"lease_percentile_25_12m": 380,
"lease_percentile_75_12m": 475,
"lease_median_1_bed_12m": 0,
"lease_median_2_bed_12m": 400,
"lease_median_3_bed_12m": 400,
"lease_median_4_bed_12m": 495,
"date": "2018-09-01",
"updated": "2018-11-01"
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves sa2 area detail and lease market trend.
HTTP Request
GET /api/sa2/{sa2_code}/rent-stats
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
SA2 ABS data
curl "/api/sa2/210011229/abs-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 816,
"state": "VIC",
"sa2_code": 210011229,
"sa2_name": "Keilor East",
"sa3_code": "21001",
"sa3_name": "Keilor",
"sa4_code": "210",
"sa4_name": "Melbourne - North West",
"gcc_code": 3,
"gcc_name": "Greater Melbourne",
"area_sqkm": 10.8916,
"abs_data": {
"data": {
"age": [
{
"age_yr_0_4": 1466,
"age_yr_5_19": 4155,
"age_yr_20_39": 6160,
"age_yr_40_59": 6693,
"age_yr_60_plus": 7677
}
],
"language_spoken_at_home": [
{
"english": 13814,
"afrikaans": 3,
"arabic": 514,
"aindlng": 7,
"chinese": 1043,
"croatian": 486,
"dutch": 19,
"french": 50,
"german": 64,
"greek": 1396,
"indo_aryan": 372,
"italian": 3180,
"japanese": 44,
"korean": 23,
"macedonian": 315,
"maltese": 296,
"polish": 126,
"russian": 14,
"samoan": 8,
"serbian": 129,
"southeast_asian_austronesian": 288,
"spanish": 321,
"tamil": 95,
"thai": 36,
"turkish": 121,
"vietnamese": 1197,
"other": 11033,
"not_stated": 1366,
"total": 26147
}
],
"type_of_education": [
{
"pre_school": 371,
"infants_primary": 1882,
"secondary": 1477,
"technical_or_further_educational": 305,
"university": 1096,
"other": 216,
"not_stated": 1628
}
],
"family_composition": [
{
"no_children": 2633,
"couple": 3476,
"one_parent": 1140,
"other": 124
}
],
"household_income_weekly": [
{
"hi_1_499": 1130,
"hi_500_999": 1724,
"hi_1000_1499": 1311,
"hi_1500_1999": 1012,
"hi_2000_2499": 904,
"hi_2500_2999": 640,
"hi_3000_3499": 429,
"hi_3500_3999": 345,
"hi_4000_more": 569
}
],
"dwelling_structure": [
{
"separate_house": 7337,
"semi_townhouse": 1729,
"flat_apart": 75,
"other": 46,
"not_stated": 12
}
],
"home_ownership": [
{
"fully_owned": 4531,
"purchasing": 2685,
"rented": 1672,
"other": 50,
"not_stated": 262
}
],
"home_loan_repayment_monthly": [
{
"m_0_299": 177,
"m_300_449": 63,
"m_450_599": 51,
"m_600_799": 72,
"m_800_999": 113,
"m_1000_1399": 322,
"m_1400_1799": 336,
"m_1800_2399": 538,
"m_2400_2999": 359,
"m_3000_3999": 333,
"m_4000_over": 165
}
],
"rent_repayment_weekly": [
{
"r_0_99": 77,
"r_100_149": 34,
"r_150_199": 41,
"r_200_224": 28,
"r_225_274": 90,
"r_275_349": 471,
"r_350_449": 637,
"r_450_549": 161,
"r_550_649": 36,
"r_650_749": 10,
"r_750_over": 16
}
],
"employment": [
{
"full_time": 6942,
"part_time": 3709,
"employed_away_from_work": 373,
"unemployed_looking_for_job": 688,
"unemployed_others": 2,
"not_in_labour_force": 8603,
"labour_force_status_not_stated": 1274
}
],
"occupation": [
{
"managers": 1435,
"professionals": 2560,
"technicians_and_trades_workers": 1491,
"community_and_personal_service_workers": 1000,
"clerical_and_administrative_workers": 1893,
"sales_workers": 1211,
"machinery_operators_and_drivers": 653,
"labourers": 817,
"inadequately_described_not_stated": 232
}
],
"number_of_hours_worked": [
{
"worked_none": 373,
"worked_1_15": 1320,
"worked_16_24": 1161,
"worked_25_34": 1234,
"worked_35_39": 2224,
"worked_40": 2320,
"worked_41_48": 948,
"worked_49over": 1448,
"not_stated": 267
}
],
"method_of_travel_to_work": [
{
"train": 375,
"tram": 57,
"bus": 116,
"car_as_driver": 7692,
"car_as_passenger": 476,
"bicycle": 41,
"walked_only": 92,
"did_not_go_to_work": 970,
"worked_at_home": 340,
"train_and_bus": 250,
"train_and_car": 248,
"other": 1610
}
]
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves SA2 Australian Bureau of Statistics data.
HTTP Request
GET /api/sa2/{sa2_code}/abs-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Suburb
Suburb Search
curl "/api/suburb/search?q=Avondale+Heights"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"value": "Avondale Heights VIC 3034",
"id": 1822,
"code": "avondale-heights-vic-3034"
}
]Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "q",
"code": "The q field is required."
}
],
"status_code": 422
}This endpoint search for suburbs by suburb name or postcode.
HTTP Request
GET /api/suburb/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | Required, search suburb name or postcode |
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb Info
curl "/api/suburb/avondale-heights-vic-3034"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034"
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail.
HTTP Request
GET /api/suburb/{suburb_code}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: suburb_info, median_sale_price, median_rent_price, schools, auction_summary, nearby_suburbs, rent_trend_data, sold_trend_data, market_trend, peak_sale, peak_rent, sold_price_range, rent_price_range |
Nearby suburbs
curl "/api/suburb/avondale-heights-vic-3034/nearby-suburbs"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"nearby_suburbs": {
"data": [
{
"id": 327,
"state": "VIC",
"name": "Keilor East",
"postcode": "3033",
"suburb_code": "keilor-east-vic-3033",
"suburb_name": "Keilor East VIC 3033"
}
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and nearby suburbs.
HTTP Request
GET /api/suburb/{suburb_code}/nearby-suburbs
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb Schools
curl "/api/suburb/avondale-heights-vic-3034/schools"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"schools": {
"data": [
{
"school_name": "Avondale Primary School",
"school_note": "Government Coeducational School",
"state": "VIC",
"address": "CLARENDON ST",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"school_type": "Primary",
"lat": -37.7669927,
"lng": 144.8609692,
"website": "http://www.avondaleps.vic.edu.au",
"phone": "03 9318 1755",
"gender": "Co-Education",
"year_range": "Prep-6",
"school_sector": "Government",
"school_id": 3076783
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and schools.
HTTP Request
GET /api/suburb/{suburb_code}/schools
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb For Sale Properties
curl "/api/suburb/avondale-heights-vic-3034/buy"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"buy": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"list_date": "2018-08-18",
"list_price": "",
"days_on_market": 3,
"pu_id": 29738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for sale in the suburb.
HTTP Request
GET /api/suburb/{suburb_code}/buy
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb For Lease Properties
curl "/api/suburb/avondale-heights-vic-3034/for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"for_lease": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"list_date": "2018-08-18",
"list_price": 500,
"pu_id": 29738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties for lease in the suburb.
HTTP Request
GET /api/suburb/{suburb_code}/for-lease
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| sort | String | date_desc |
Optional, Allowed values: price_desc, price_asc, date_desc |
| type | String | Property Type | Optional: house,unit,townhouse,apartment,studio |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 7, -1 means all |
| bath | Integer | Property Bathrooms | Optional, Allowed values: between -1 and 7, -1 means all |
| car | Integer | Property Car Spaces | Optional, Allowed values: between -1 and 7, -1 means all |
| price_high | Integer | 0 |
Optional |
| price_low | Integer | 0 |
Optional |
| address | String | Address | Optional, not include suburb name and postcode, only street number, street name and street type |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 50 |
Suburb Sold Properties
curl "/api/suburb/avondale-heights-vic-3034/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties sold within last 30 days in the suburb.
HTTP Request
GET /api/suburb/{suburb_code}/sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb Rent Properties
curl "/api/suburb/avondale-heights-vic-3034/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"rent_date": "2018-08-18",
"rent_price": 500,
"pu_id": 29738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties rent within last 30 days in the suburb.
HTTP Request
GET /api/suburb/{suburb_code}/rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Suburb Sold Trend Data
curl "/api/suburb/avondale-heights-vic-3034/sold-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"sold_trend_data": {
"data": {
"investor_metrics": {
"median_price": 802500,
"median_price_12_months_ago": 820000,
"annual_growth_last_12_months": -0.0213
},
"invested_performance": {
"2017-08": 100,
"2017-09": 102.18
},
"trend_list": {
"2017-08": {
"price_avg": 780255,
"price_median": 802500,
"standard_deviation": 236961,
"price_min": 38350,
"price_10th": 500000,
"price_20th": 610000,
"price_25th": 640000,
"price_30th": 694000,
"price_40th": 750000,
"price_50th": 802500,
"price_60th": 835000,
"price_70th": 860000,
"price_75th": 875500,
"price_80th": 920000,
"price_90th": 1085000,
"price_max": 1680000,
"num_all": 265,
"num_all_with_price": 214,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 797468,
"price_median": 820000,
"standard_deviation": 234821,
"price_min": 38350,
"price_10th": 470000,
"price_20th": 625000,
"price_25th": 690000,
"price_30th": 720000,
"price_40th": 773000,
"price_50th": 820000,
"price_60th": 850000,
"price_70th": 872000,
"price_75th": 890000,
"price_80th": 934000,
"price_90th": 1085000,
"price_max": 1680000,
"num_all": 237,
"num_all_with_price": 193,
"start_date": "2016-10-01",
"end_date": "2017-09-30",
"growth": 0.0218
}
},
"filter": {
"suburb_id": 1822
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and sold trend data.
HTTP Request
GET /api/suburb/{suburb_code}/sold-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
Suburb Rent Trend Data
curl "/api/suburb/avondale-heights-vic-3034/rent-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"rent_trend_data": {
"data": {
"investor_metrics": {
"median_price": 400,
"median_price_12_months_ago": 390,
"annual_growth_last_12_months": 0.0256
},
"invested_performance": {
"2017-08": 100,
"2017-09": 100
},
"trend_list": {
"2017-08": {
"price_avg": 409,
"price_median": 390,
"standard_deviation": 192,
"price_min": 180,
"price_10th": 285,
"price_20th": 325,
"price_25th": 340,
"price_30th": 350,
"price_40th": 375,
"price_50th": 390,
"price_60th": 400,
"price_70th": 420,
"price_75th": 440,
"price_80th": 450,
"price_90th": 500,
"price_max": 2607,
"num_all": 341,
"num_all_with_price": 338,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 403,
"price_median": 390,
"standard_deviation": 143,
"price_min": 180,
"price_10th": 300,
"price_20th": 330,
"price_25th": 340,
"price_30th": 350,
"price_40th": 375,
"price_50th": 390,
"price_60th": 400,
"price_70th": 420,
"price_75th": 445,
"price_80th": 450,
"price_90th": 500,
"price_max": 2308,
"num_all": 360,
"num_all_with_price": 355,
"start_date": "2016-10-01",
"end_date": "2017-09-30",
"growth": 0
}
},
"filter": {
"suburb_id": 1822
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and rent trend data.
HTTP Request
GET /api/suburb/{suburb_code}/rent-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
Suburb Median Sale Price
curl "/api/suburb/avondale-heights-vic-3034/median-sale-price"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"median_sale_price": {
"data": {
"2018-07-31": 880000,
"2018-08-31": 900000,
"2018-09-30": 880000,
"2018-10-31": 881000,
"2018-11-30": 860000,
"2018-12-31": 860000,
"2019-01-31": 850000,
"2019-02-28": 860000,
"2019-03-31": 850000,
"2019-04-30": 835000,
"2019-05-31": 820000,
"2019-06-30": 810000
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and median sale price.
HTTP Request
GET /api/suburb/{suburb_code}/median-sale-price
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, year |
Suburb Median Rent Price
curl "/api/suburb/avondale-heights-vic-3034/median-rent-price"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"median_rent_price": {
"data": {
"2018-07-31": 420,
"2018-08-31": 420,
"2018-09-30": 425,
"2018-10-31": 430,
"2018-11-30": 430,
"2018-12-31": 430,
"2019-01-31": 430,
"2019-02-28": 430,
"2019-03-31": 430,
"2019-04-30": 430,
"2019-05-31": 430,
"2019-06-30": 430
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and median rent price.
HTTP Request
GET /api/suburb/{suburb_code}/median-rent-price
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| date_type | String | month |
Optional, Allowed values: month, year |
Suburb Sale-O-Meter
curl "/api/suburb/avondale-heights-vic-3034/saleometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"saleometer": {
"data": {
"price_avg": 803336,
"price_median": 802000,
"standard_deviation": 207559,
"price_min": 200000,
"price_10th": 550000,
"price_20th": 630000,
"price_25th": 681100,
"price_30th": 710500,
"price_40th": 760000,
"price_50th": 802000,
"price_60th": 838000,
"price_70th": 910000,
"price_75th": 935000,
"price_80th": 970000,
"price_90th": 1066000,
"price_max": 1400000,
"num_all": 185,
"num_all_with_price": 160,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"suburb_id": 1822
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and sale-o-meter.
HTTP Request
GET /api/suburb/{suburb_code}/saleometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
Suburb Rent-O-Meter
curl "/api/suburb/avondale-heights-vic-3034/rentometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"rentometer": {
"data": {
"price_avg": 423,
"price_median": 400,
"standard_deviation": 93,
"price_min": 190,
"price_10th": 330,
"price_20th": 350,
"price_25th": 360,
"price_30th": 375,
"price_40th": 395,
"price_50th": 400,
"price_60th": 420,
"price_70th": 450,
"price_75th": 450,
"price_80th": 485,
"price_90th": 530,
"price_max": 900,
"num_all": 339,
"num_all_with_price": 334,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"suburb_id": 1822
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and rent-o-meter.
HTTP Request
GET /api/suburb/{suburb_code}/rentometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
| bed | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
Suburb Sale Stats
curl "/api/suburb/avondale-heights-vic-3034/sale-stats"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"sale_stats": {
"data": {
"property_type": "house",
"address_count": 4062,
"median_bed_count": 3,
"median_bath_count": 2,
"median_car_count": 2,
"for_sale_new_volume_1m": 4,
"for_sale_new_volume_3m": 21,
"for_sale_new_volume_6m": 55,
"for_sale_new_volume_12m": 72,
"for_sale_active_volume_1m": 28,
"for_sale_active_volume_3m": 49,
"for_sale_active_volume_6m": 69,
"for_sale_active_volume_12m": 79,
"for_sale_dom_median_12m": 31,
"for_sale_discount_median_12m": 5.2999999999999998,
"for_sale_median_list_price_12m": 852930,
"sale_volume_12m": 91,
"sale_turnover_12m": 2.2000000000000002,
"sale_sum_12m": 64545026,
"sale_minimum_12m": 550000,
"sale_maximum_12m": 1458888,
"sale_median_12m": 835000,
"sale_percentile_25_12m": 775000,
"sale_percentile_75_12m": 1000000,
"sale_median_1_bed_12m": 0,
"sale_median_2_bed_12m": 681100,
"sale_median_3_bed_12m": 800000,
"sale_median_4_bed_12m": 1060000,
"date": "2019-02-01",
"updated": "2019-02-05"
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and sale market trend.
HTTP Request
GET /api/suburb/{suburb_code}/sale-stats
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
Suburb Rent Stats
curl "/api/suburb/avondale-heights-vic-3034/rent-stats"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"rent_stats": {
"data": {
"property_type": "house",
"address_count": 4062,
"median_bed_count": 3,
"median_bath_count": 2,
"median_car_count": 2,
"for_lease_new_volume_1m": 13,
"for_lease_new_volume_3m": 41,
"for_lease_new_volume_6m": 75,
"for_lease_new_volume_12m": 172,
"for_lease_active_volume_1m": 27,
"for_lease_active_volume_3m": 63,
"for_lease_active_volume_6m": 107,
"for_lease_active_volume_12m": 188,
"for_lease_dom_median_12m": 23,
"for_lease_discount_median_12m": 0,
"lease_volume_12m": 177,
"lease_turnover_12m": 4.4000000000000004,
"lease_sum_12m": 79875,
"lease_minimum_12m": 260,
"lease_maximum_12m": 875,
"lease_median_12m": 430,
"lease_percentile_25_12m": 400,
"lease_percentile_75_12m": 500,
"lease_median_1_bed_12m": 440,
"lease_median_2_bed_12m": 420,
"lease_median_3_bed_12m": 420,
"lease_median_4_bed_12m": 550,
"date": "2019-02-01",
"updated": "2019-02-05"
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb detail and lease market trend.
HTTP Request
GET /api/suburb/{suburb_code}/rent-stats
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | house |
Optional, Allowed values: house, unit |
Suburb Auction Results
curl "/api/suburb/avondale-heights-vic-3034/auction-results"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"auction_results": {
"data": [
{
"address": "21 Medfield Avenue",
"state": "VIC",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"type": "house",
"bed": 4,
"sold_date": "2018-08-18",
"price": 850000,
"result": "Sold",
"is_sold": true,
"pu_id": 4247017665,
"agency": "Agency"
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves auction results within last 30 days in the suburb.
HTTP Request
GET /api/suburb/{suburb_code}/auction-results
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| limit | Integer | 10 | Optional, Allowed values: between 1 and 50 |
Suburb ABS data
curl "/api/suburb/avondale-heights-vic-3034/abs-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"id": 1822,
"state": "VIC",
"name": "Avondale Heights",
"postcode": "3034",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights VIC 3034",
"abs_data": {
"data": {
"age": [
{
"age_yr_0_4": 636,
"age_yr_5_19": 1701,
"age_yr_20_39": 2825,
"age_yr_40_59": 2890,
"age_yr_60_plus": 3589
}
],
"language_spoken_at_home": [
{
"english": 5141,
"afrikaans": 0,
"arabic": 240,
"aindlng": 3,
"chinese": 583,
"croatian": 325,
"dutch": 8,
"french": 26,
"german": 27,
"greek": 641,
"indo_aryan": 168,
"italian": 1643,
"japanese": 19,
"korean": 18,
"macedonian": 191,
"maltese": 133,
"polish": 66,
"russian": 4,
"samoan": 0,
"serbian": 75,
"southeast_asian_austronesian": 169,
"spanish": 192,
"tamil": 36,
"thai": 16,
"turkish": 54,
"vietnamese": 776,
"other": 5911,
"not_stated": 612,
"total": 11633
}
],
"type_of_education": [
{
"pre_school": 160,
"infants_primary": 752,
"secondary": 598,
"technical_or_further_educational": 135,
"university": 474,
"other": 110,
"not_stated": 740
}
],
"family_composition": [
{
"no_children": 1192,
"couple": 1501,
"one_parent": 512,
"other": 59
}
],
"household_income_weekly": [
{
"hi_1_499": 548,
"hi_500_999": 811,
"hi_1000_1499": 591,
"hi_1500_1999": 452,
"hi_2000_2499": 387,
"hi_2500_2999": 252,
"hi_3000_3499": 164,
"hi_3500_3999": 140,
"hi_4000_more": 234
}
],
"dwelling_structure": [
{
"separate_house": 3194,
"semi_townhouse": 851,
"flat_apart": 21,
"other": 29,
"not_stated": 5
}
],
"home_ownership": [
{
"fully_owned": 2132,
"purchasing": 1057,
"rented": 751,
"other": 27,
"not_stated": 129
}
],
"home_loan_repayment_monthly": [
{
"m_0_299": 64,
"m_300_449": 26,
"m_450_599": 18,
"m_600_799": 20,
"m_800_999": 39,
"m_1000_1399": 147,
"m_1400_1799": 138,
"m_1800_2399": 208,
"m_2400_2999": 138,
"m_3000_3999": 119,
"m_4000_over": 65
}
],
"rent_repayment_weekly": [
{
"r_0_99": 37,
"r_100_149": 23,
"r_150_199": 29,
"r_200_224": 16,
"r_225_274": 52,
"r_275_349": 220,
"r_350_449": 265,
"r_450_549": 63,
"r_550_649": 13,
"r_650_749": 11,
"r_750_over": 11
}
],
"employment": [],
"occupation": [
{
"managers": 589,
"professionals": 1069,
"technicians_and_trades_workers": 639,
"community_and_personal_service_workers": 402,
"clerical_and_administrative_workers": 793,
"sales_workers": 520,
"machinery_operators_and_drivers": 283,
"labourers": 391,
"inadequately_described_not_stated": 117
}
],
"number_of_hours_worked": [
{
"worked_none": 168,
"worked_1_15": 549,
"worked_16_24": 477,
"worked_25_34": 542,
"worked_35_39": 990,
"worked_40": 985,
"worked_41_48": 357,
"worked_49over": 595,
"not_stated": 130
}
],
"method_of_travel_to_work": [
{
"train": 163,
"tram": 35,
"bus": 50,
"car_as_driver": 3242,
"car_as_passenger": 210,
"bicycle": 22,
"walked_only": 48,
"did_not_go_to_work": 412,
"worked_at_home": 119,
"train_and_bus": 93,
"train_and_car": 100,
"other": 716
}
]
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves suburb Australian Bureau of Statistics data.
HTTP Request
GET /api/suburb/{suburb_code}/abs-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Building
Building Search
curl "/api/building/search?q=220+Spencer+Street"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"building_pid": "VIC1524539",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne"
}
]Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "q",
"code": "The q field is required."
}
],
"status_code": 422
}This endpoint search for properties by street number, street name and suburb name or postcode.
HTTP Request
GET /api/building/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | Required, search address, street name, suburb name and postcode |
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Info
curl "/api/building/220-spencer-st-melbourne-vic-3000"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne"
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail by building_code or gnaf_building_id.
HTTP Request
GET /api/building/{building_code}
GET /api/building/{gnaf_building_id}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: price_range, building_sold_trend, building_rent_trend, building_median_rentals, building_median_sales, suburb_sold_trend, suburb_rent_trend, suburb_median_rentals, suburb_median_sales |
Building Properties
curl "/api/building/220-spencer-st-melbourne-vic-3000/property"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/property"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"property": {
"data": [
{
"state": "VIC",
"address_code": "unit-1008-220-spencer-st-melbourne-vic-3000",
"gnaf_address_id": "GAVIC425247941",
"address": "1008/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"sa2_code": 206041122,
"lat": "-37.8155837",
"lng": "144.9530742",
"image": "https://imgurl",
"type": "unit",
"bed": 0,
"bath": 0,
"car": 0,
"land": "",
"building": 0,
"year_built": 0,
"lot_plan": ""
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and properties.
HTTP Request
GET /api/building/{building_code}/property
GET /api/building/{gnaf_building_id}/property
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building History
curl "/api/building/220-spencer-st-melbourne-vic-3000/history"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/history"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"history": {
"data": [
{
"gnaf_address_id": "GAVIC425233623",
"state": "VIC",
"address": "L 4 7014Y/220 Spencer Street",
"suburb_name": "Melbourne",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"image": "https://imgurl",
"type": "unit",
"bed": 0,
"bath": 0,
"car": 0,
"event": "Sold",
"date": "2018-10-03",
"price": 67000
}
],
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and sales/rentals history records.
HTTP Request
GET /api/building/{building_code}/history
GET /api/building/{gnaf_building_id}/history
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building For Sale
curl "/api/building/220-spencer-st-melbourne-vic-3000/buy"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/buy"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"buy": {
"data": [
{
"state": "VIC",
"address": "1302/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 2,
"bath": 2,
"car": 0,
"lat": -37.815581999999999,
"lng": 144.95308,
"land": "",
"list_date": "2019-07-22",
"list_price": "$510,000",
"gnaf_pid": "GAVIC425232863",
"pu_id": 19755371546
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and for sale listings.
HTTP Request
GET /api/building/{building_code}/buy
GET /api/building/{gnaf_building_id}/buy
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building For Lease
curl "/api/building/220-spencer-st-melbourne-vic-3000/for-lease"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"for_lease": {
"data": [
{
"state": "VIC",
"address": "1914/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 1,
"bath": 1,
"car": 0,
"lat": -37.815581999999999,
"lng": 144.95308,
"rent_date": "2019-07-25",
"rent_price": 470,
"gnaf_pid": "GAVIC425248034",
"pu_id": 29913794832
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and for lease listings.
HTTP Request
GET /api/building/{building_code}/for-lease
GET /api/building/{gnaf_building_id}/for-lease
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Sold
curl "/api/building/220-spencer-st-melbourne-vic-3000/sold"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"sold": {
"data": [
{
"state": "VIC",
"address": "2918/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 2,
"bath": 2,
"car": 1,
"lat": -37.815581999999999,
"lng": 144.95308,
"land": "",
"sold_date": "2019-01-24",
"sold_price": 0,
"gnaf_pid": "GAVIC425326747",
"pu_id": 39732121014
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and sold listings.
HTTP Request
GET /api/building/{building_code}/sold
GET /api/building/{gnaf_building_id}/sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Rent
curl "/api/building/220-spencer-st-melbourne-vic-3000/rent"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"rent": {
"data": [
{
"state": "VIC",
"address": "1914/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 1,
"bath": 1,
"car": 0,
"lat": -37.815581999999999,
"lng": 144.95308,
"rent_date": "2019-07-25",
"rent_price": 470,
"gnaf_pid": "GAVIC425248034",
"pu_id": 29913794832
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and rent listings.
HTTP Request
GET /api/building/{building_code}/rent
GET /api/building/{gnaf_building_id}/rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Top Sale Agency
curl "/api/building/220-spencer-st-melbourne-vic-3000/top-sale-agency"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/top-sale-agency"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"top_sale_agency": {
"data": [
{
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
]
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and top sale agencies by number of for sale and sold listings in last 5 years.
HTTP Request
GET /api/building/{building_code}/top-sale-agency
GET /api/building/{gnaf_building_id}/top-sale-agency
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Top Rental Agency
curl "/api/building/220-spencer-st-melbourne-vic-3000/top-rental-agency"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/top-rental-agency"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"top_rental_agency": {
"data": [
{
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
]
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and top rental agencies by number of for sale and sold listings in last 5 years.
HTTP Request
GET /api/building/{building_code}/top-rental-agency
GET /api/building/{gnaf_building_id}/top-rental-agency
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Nearby For Sale
curl "/api/building/220-spencer-st-melbourne-vic-3000/nearby-for-sale"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/nearby-for-sale"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"nearby_for_sale": {
"data": [
{
"state": "VIC",
"address": "1302/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 2,
"bath": 2,
"car": 0,
"lat": -37.815581999999999,
"lng": 144.95308,
"land": "",
"list_date": "2019-07-22",
"list_price": "$510,000",
"gnaf_pid": "GAVIC425232863",
"pu_id": 19755371546,
"distance": 0
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and nearby for sale listings.
HTTP Request
GET /api/building/{building_code}/nearby-for-sale
GET /api/building/{gnaf_building_id}/nearby-for-sale
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Nearby For Lease
curl "/api/building/220-spencer-st-melbourne-vic-3000/nearby-for-lease"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/nearby-for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"nearby_for_lease": {
"data": [
{
"state": "VIC",
"address": "1914/220 Spencer Street",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"image": "https://imageurl",
"type": "apartment",
"bed": 1,
"bath": 1,
"car": 0,
"lat": -37.815581999999999,
"lng": 144.95308,
"rent_date": "2019-07-25",
"rent_price": 470,
"gnaf_pid": "GAVIC425248034",
"pu_id": 29913794832,
"distance": 0
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and nearby for lease listings.
HTTP Request
GET /api/building/{building_code}/nearby-for-lease
GET /api/building/{gnaf_building_id}/nearby-for-lease
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Building Nearby Schools
curl "/api/building/220-spencer-st-melbourne-vic-3000/nearby-schools"
-H "Authorization: Bearer TOKEN"curl "/api/building/VIC1524539/nearby-schools"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"gnaf_building_id": "VIC1524539",
"building_code": "220-spencer-st-melbourne-vic-3000",
"building_name": "220 Spencer Street",
"street_number": "220",
"street_name": "Spencer Street",
"suburb_name": "Melbourne",
"state": "VIC",
"postcode": "3000",
"lat": "-37.8155837",
"lng": "144.9530742",
"lots": 1853,
"year_built": 2013,
"plan": "PS633275",
"mb_category": "Commercial",
"sa1_id": "20604112219",
"sa1_area_sqkm": "0.0539",
"sa2_name": "Melbourne",
"sa3_name": "Melbourne City",
"sa4_name": "Melbourne - Inner",
"gcc_name": "Greater Melbourne",
"council": "Melbourne",
"nearby-schools": {
"data": [
{
"school_name": "Eltham College of Education City Campus",
"school_note": "",
"state": "VIC",
"address": "",
"suburb_code": "melbourne-vic-3000",
"suburb_name": "Melbourne",
"postcode": "3000",
"school_type": "Combined",
"lat": -37.817236000000001,
"lng": 144.9558251,
"website": "",
"phone": "",
"gender": "",
"year_range": "",
"school_sector": "Independent",
"school_id": 3470654,
"distance": 0.30 //distance in km
}
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves building detail and nearby schools.
HTTP Request
GET /api/building/{building_code}/nearby-schools
GET /api/building/{gnaf_building_id}/nearby-schools
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Property
Property Search
curl "/api/property/search?q=12A+Doyle+Street+Avondale+Heights"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
[
{
"address": "12A Doyle Street, Avondale Heights Vic 3034",
"code": "12a-doyle-st-avondale-heights-vic-3034",
"state": "VIC",
"suburb": "Avondale Heights",
"postcode": "3034"
}
]Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "q",
"code": "The q field is required."
}
],
"status_code": 422
}This endpoint search for properties by street number, street name and suburb name or postcode.
HTTP Request
GET /api/property/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| q | String | Required, search address, street name, suburb name and postcode |
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Property Info By Id
curl "/api/property/info/39711989164"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address": "77 Thompson Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imgurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 3,
"land": "",
"sold_date": "2018-09-08",
"sold_price": 860000,
"pu_id": 39711989164
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail by property unique id (pu_id).
HTTP Request
GET /api/property/info/{pu_id}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: images, description, history, estimate |
Property Info By Address
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034"
-H "Authorization: Bearer TOKEN"curl "/api/property/GAVIC421012645"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"sa2_code": 210011229,
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460"
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail by address_code or gnaf_address_id
HTTP Request
GET /api/property/{address_code}
GET /api/property/{gnaf_address_id}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: images, description, history, estimate, similar_sold, similar_rent, nearby_properties, nearby_schools, sa1_profile, suburb_info, suburb_trends, auction_summary, sa1_abs_data |
Property History
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/history"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"history": {
"data": [
{
"event": "Rent",
"date": "2018-08-27",
"price": 405,
"agency": "Moonee Valley Real Estate Avondale Heights"
},
{
"event": "Sold",
"date": "2017-07-03",
"price": 622000,
"agency": "Moonee Valley Real Estate - Avondale Heights"
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail with sales and rental history.
HTTP Request
GET /api/property/{address_code}/history
GET /api/property/{gnaf_address_id}/history
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Nearby Properties
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/nearby-properties"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"nearby_properties": {
"data": [
{
"state": "VIC",
"address_code": "10-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421091568",
"address": "10 Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7623900",
"lng": "144.8599750",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "600",
"building": 0,
"year_built": 1980,
"lot_plan": "61/LP63093"
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and nearby properties.
HTTP Request
GET /api/property/{address_code}/nearby-properties
GET /api/property/{gnaf_address_id}/nearby-properties
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Property Nearby Schools
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/nearby-schools"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"nearby_schools": {
"data": [
{
"school_name": "St Martin de Porres School",
"school_note": "Catholic Coeducational School",
"state": "VIC",
"address": "158 MILITARY RD",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"school_type": "Primary",
"lat": -37.758398,
"lng": 144.861398,
"website": "http://www.smavondaleheights.catholic.edu.au",
"phone": "03 9331 9000",
"gender": "Co-Education",
"year_range": "U, Prep-6",
"school_sector": "Catholic",
"school_id": 3179060,
"distance": 0.44 //distance in km
},
// more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and nearby schools.
HTTP Request
GET /api/property/{address_code}/nearby-schools
GET /api/property/{gnaf_address_id}/nearby-schools
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Similar Sold Properties
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/similar-sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"similar_sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and comparable sold properties.
HTTP Request
GET /api/property/{address_code}/similar-sold
GET /api/property/{gnaf_address_id}/similar-sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | String | Property Type | Optional |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 9, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| radius | Integer | 3 |
Optional, Allowed values: between 1 and 5 km |
| price_high | Integer | 0 |
Optional |
| price_low | Integer | 0 |
Optional |
| land_high | Integer | 0 |
Optional |
| land_low | Integer | 0 |
Optional |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 50 |
Similar Rent Properties
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/similar-rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"similar_rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"rent_date": "2018-08-18",
"rent_price": 500,
"pu_id": 29738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and comparable rent properties.
HTTP Request
GET /api/property/{address_code}/similar-rent
GET /api/property/{gnaf_address_id}/similar-rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | String | Property Type | Optional |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 9, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| radius | Integer | 3 |
Optional, Allowed values: between 1 and 5 km |
| price_high | Integer | 0 |
Optional |
| price_low | Integer | 0 |
Optional |
| land_high | Integer | 0 |
Optional |
| land_low | Integer | 0 |
Optional |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| limit | Integer | 10 |
Optional, Allowed values: between 1 and 50 |
Property Sold Trend Data
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/sold-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"sold_trend_data": {
"data": {
"investor_metrics": {
"median_price": 820000,
"median_price_12_months_ago": 790000,
"annual_growth_last_12_months": 0.038
},
"invested_performance": {
"2017-08": 100,
"2017-09": 102
},
"trend_list": {
"2017-08": {
"price_avg": 771696,
"price_median": 774500,
"standard_deviation": 159555,
"price_min": 155000,
"price_10th": 590000,
"price_20th": 627500,
"price_25th": 660000,
"price_30th": 680000,
"price_40th": 725000,
"price_50th": 774500,
"price_60th": 815000,
"price_70th": 850000,
"price_75th": 865000,
"price_80th": 875500,
"price_90th": 941000,
"price_max": 1625000,
"num_all": 295,
"num_all_with_price": 243,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 779673,
"price_median": 790000,
"standard_deviation": 164675,
"price_min": 155000,
"price_10th": 595000,
"price_20th": 630000,
"price_25th": 680000,
"price_30th": 695000,
"price_40th": 735000,
"price_50th": 790000,
"price_60th": 825000,
"price_70th": 860000,
"price_75th": 872000,
"price_80th": 881000,
"price_90th": 950000,
"price_max": 1625000,
"num_all": 275,
"num_all_with_price": 227,
"start_date": "2016-10-01",
"end_date": "2017-09-30",
"growth": 0.02
}
},
"filter": {
"property_type": "house",
"num_of_bed": 3,
"radius_in_km": 2
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and sold trend data.
HTTP Request
GET /api/property/{address_code}/sold-trend-data
GET /api/property/{gnaf_address_id}/sold-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| radius | Integer | 2 |
Optional, Allowed values: between 1 and 5 km |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
Property Rent Trend Data
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/rent-trend-data"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"rent_trend_data": {
"data": {
"investor_metrics": {
"median_price": 400,
"median_price_12_months_ago": 390,
"annual_growth_last_12_months": 0.0256
},
"invested_performance": {
"2017-08": 100,
"2017-09": 100
},
"trend_list": {
"2017-08": {
"price_avg": 398,
"price_median": 390,
"standard_deviation": 66,
"price_min": 275,
"price_10th": 320,
"price_20th": 340,
"price_25th": 350,
"price_30th": 360,
"price_40th": 370,
"price_50th": 390,
"price_60th": 400,
"price_70th": 420,
"price_75th": 430,
"price_80th": 450,
"price_90th": 485,
"price_max": 700,
"num_all": 309,
"num_all_with_price": 300,
"start_date": "2016-09-01",
"end_date": "2017-08-31",
"growth": ""
},
"2017-09": {
"price_avg": 434,
"price_median": 400,
"standard_deviation": 168,
"price_min": 260,
"price_10th": 340,
"price_20th": 350,
"price_25th": 360,
"price_30th": 365,
"price_40th": 380,
"price_50th": 400,
"price_60th": 410,
"price_70th": 430,
"price_75th": 450,
"price_80th": 460,
"price_90th": 540,
"price_max": 1695,
"num_all": 298,
"num_all_with_price": 296,
"start_date": "2017-09-01",
"end_date": "2018-08-31",
"growth": 0
}
},
"filter": {
"property_type": "house",
"num_of_bed": 3,
"radius_in_km": 2
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and rent trend data.
HTTP Request
GET /api/property/{address_code}/rent-trend-data
GET /api/property/{gnaf_address_id}/rent-trend-data
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| radius | Integer | 2 |
Optional, Allowed values: between 1 and 5 km |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| date_type | String | month |
Optional, Allowed values: month, 12m, 24m, 36m, 48m, 60m, year, 3y, 5y, 10y. month => 12m, year => 10y |
Property Sale-O-Meter
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/saleometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"saleometer": {
"data": {
"price_avg": 822389,
"price_median": 820000,
"standard_deviation": 177757,
"price_min": 135000,
"price_10th": 635000,
"price_20th": 725000,
"price_25th": 732000,
"price_30th": 750000,
"price_40th": 782500,
"price_50th": 820000,
"price_60th": 845000,
"price_70th": 900000,
"price_75th": 912000,
"price_80th": 940000,
"price_90th": 1011000,
"price_max": 1600000,
"num_all": 167,
"num_all_with_price": 157,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"property_type": "house",
"num_of_bed": 3,
"radius_in_km": 2
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and sale-o-meter.
HTTP Request
GET /api/property/{address_code}/saleometer
GET /api/property/{gnaf_address_id}/saleometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| radius | Integer | 2 |
Optional, Allowed values: between 1 and 5 km |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
Property Rent-O-Meter
curl "/api/property/12a-doyle-st-avondale-heights-vic-3034/rentometer"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"state": "VIC",
"address_code": "12a-doyle-st-avondale-heights-vic-3034",
"gnaf_address_id": "GAVIC421012645",
"address": "12A Doyle Street",
"suburb_code": "avondale-heights-vic-3034",
"suburb_name": "Avondale Heights",
"postcode": "3034",
"lat": "-37.7621540",
"lng": "144.8598680",
"image": "https://imageurl",
"type": "house",
"bed": 3,
"bath": 1,
"car": 1,
"land": "204",
"building": 0,
"year_built": 1975,
"lot_plan": "2/PS305460",
"rentometer": {
"data": {
"price_avg": 434,
"price_median": 400,
"standard_deviation": 169,
"price_min": 260,
"price_10th": 340,
"price_20th": 350,
"price_25th": 360,
"price_30th": 365,
"price_40th": 380,
"price_50th": 400,
"price_60th": 405,
"price_70th": 430,
"price_75th": 450,
"price_80th": 460,
"price_90th": 530,
"price_max": 1695,
"num_all": 292,
"num_all_with_price": 290,
"start_date": "2017-09-12",
"end_date": "2018-09-12",
"filter": {
"property_type": "house",
"num_of_bed": 3,
"radius_in_km": 2
}
}
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves property detail and rent-o-meter.
HTTP Request
GET /api/property/{address_code}/rentometer
GET /api/property/{gnaf_address_id}/rentometer
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| type | Integer | Property Type | Optional, Allowed values: house, unit |
| bed | Integer | Property Bedrooms | Optional, Allowed values: between -1 and 5, -1 means all, 5 means 5 and more bedrooms when type is house, 4 or 5 means 4 and more bedrooms when type is unit |
| bath | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| car | Integer | -1 |
Optional, Allowed values: between -1 and 5, -1 means all |
| last_x_months | Integer | 12 |
Optional, Allowed values: between 1 and 120 months |
| radius | Integer | 2 |
Optional, Allowed values: between 1 and 5 km |
| only_same_suburb | String | no |
Optional, Allowed values: yes, no |
| include_listing | String | no |
Optional, Allowed values: yes, no, return maximum 100 properties when value is set to yes |
Agency
Agency Search
curl "/api/agency/search?email=xxx@xxx.com"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
]
}
]
}Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "email",
"code": "The email field is required."
}
],
"status_code": 422
}This endpoint search for agencys by email address.
HTTP Request
GET /api/agency/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| String | Required, valid email address |
Agency Info
curl "/api/agency/VIC00001"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
]
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves the agency information.
HTTP Request
GET /api/agency/{agency_code}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: sold, rent, buy, for-lease |
Agency For Sale Properties
curl "/api/agency/VIC00001/buy"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"buy": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agency_code": "avondale-heights-vic-3034",
"agency_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for sale by the agency.
HTTP Request
GET /api/agency/{agency_code}/buy
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agency For Lease Properties
curl "/api/agency/VIC00001/for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"for-lease": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agency_code": "avondale-heights-vic-3034",
"agency_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for lease by the agency.
HTTP Request
GET /api/agency/{agency_code}/for-lease
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agency Rent Properties
curl "/api/agency/VIC00001/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agency_code": "avondale-heights-vic-3034",
"agency_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as leased by the agency.
HTTP Request
GET /api/agency/{agency_code}/rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agency Sold Properties
curl "/api/agency/VIC00001/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agency_code": "VIC00001",
"name": "agency name",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agency_code": "avondale-heights-vic-3034",
"agency_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties sold within last 12 months by the agency.
HTTP Request
GET /api/agency/{agency_code}/sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agent
Agent Search
curl "/api/agent/search?email=xxx@xxx.com"
-H "Authorization: Bearer TOKEN"curl "/api/agent/search?name=firstname lastname"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": [
{
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name"
}
]
}Error Response: HTTP/1.1 422
{
"message": "422 Unprocessable Entity",
"errors": [
{
"field": "email",
"code": "The email field is required."
}
],
"status_code": 422
}This endpoint search for agents by email address or agent name.
HTTP Request
GET /api/agent/search
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| String | Required if name is not present, valid email address | |
| name | String | Required if email is not present |
Agent Info
curl "/api/agent/VIC00001"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name"
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves agent information.
HTTP Request
GET /api/agent/{agent_code}
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| include | String | Optional, Allowed values: sold, rent, buy, for-lease |
Agent For Sale Properties
curl "/api/agent/VIC00001/buy"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name",
"buy": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for sale by the agent.
HTTP Request
GET /api/agent/{agent_code}/buy
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agent For Lease Properties
curl "/api/agent/VIC00001/for-lease"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name",
"for-lease": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as for lease by the agent.
HTTP Request
GET /api/agent/{agent_code}/for-lease
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agent Rent Properties
curl "/api/agent/VIC00001/rent"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name",
"rent": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties listed as leased by the agent.
HTTP Request
GET /api/agent/{agent_code}/rent
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Agent Sold Properties
curl "/api/agent/VIC00001/sold"
-H "Authorization: Bearer TOKEN"Succss Response: HTTP/1.1 200 OK
{
"data": {
"agent_code": "VIC00001",
"name": "firstname lastname",
"phone": "0400 000 000",
"email": [
"xxx@xxx.com"
],
"agency": "agency name",
"sold": {
"data": [
{
"state": "VIC",
"address": "21 Medfield Avenue",
"agent_code": "avondale-heights-vic-3034",
"agent_name": "Avondale Heights",
"postcode": "3034",
"image": "https://imageurl",
"type": "house",
"bed": 4,
"bath": 2,
"car": 2,
"land": "",
"sold_date": "2018-08-18",
"sold_price": 850000,
"pu_id": 19738058454
},
//more data here
]
}
}
}Error Response: HTTP/1.1 404 Not Found
{
"message": "404 Not Found",
"status_code": 404
}This endpoint retrieves properties sold within last 12 months by the agent.
HTTP Request
GET /api/agent/{agent_code}/sold
Header
| Field | Type | Description |
|---|---|---|
| Authorization | String | user jwtToken, value start with Bearer |
Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Optional, Allowed values: between 1 and 50 |
Errors
The API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request sucks |
| 401 | Unauthorized -- Invalid Token or Token has expired |
| 403 | Forbidden -- The kitten requested is hidden for administrators only |
| 404 | Not Found -- The specified kitten could not be found |
| 405 | Method Not Allowed -- You tried to access a kitten with an invalid method |
| 406 | Not Acceptable -- You requested a format that isn't json |
| 410 | Gone -- The kitten requested has been removed from our servers |
| 418 | I'm a teapot |
| 429 | Too Many Requests -- You're requesting too many kittens! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later. |