The Archistar API allows you to find development potential on any block of land by just providing a street address. It also allows you to view detailed zoning for any block of land in a standardised format.
Here you will find a complete listing of all endpoints, including parameters and sample requests and responses.
Returns estimated property feasiblity
This endpoint provides the flexibility to either calculate estimated feasibility for all different dwelling types.
The calculation can be based on the ArchiStar's recommended defaults or based on the variables provided within the request.
Endpoint
POST https://api.archistar.ai/v1/property/estimate
Sample Request Params (in POST Body)
{
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669",
"total_property_area_m2": "0,",
"street_frontage_m": "0,",
"min_lot_size_m2": "0,",
"min_lot_size_multi_dwellings_m2": "0,",
"minimum_lot_width": "0,",
"max_allowed_fsr": "0,",
"max_allowed_building_height_m": "0,",
"max_allowed_dwelling_density": "0,",
"setback_front": "0,",
"setback_rear": "0,",
"setback_side": "0,",
"th_depth": "0,",
"th_width": "0,",
"site_coverage_area_pct": "0,",
"floor_height_m": "0,",
"bld_efficiency_ratio_pct": "0,",
"floor_efficiency_ratio_pct": "0,",
"avg_apt_area-m2": 0
}
Sample Response
{
"result": {
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669",
"feasibility": {
"duplex": {
"optimalCalculationType": null,
"calculations": []
},
"townhouse": {
"optimalCalculationType": "attached",
"calculations": {
"attached": {
"gfa_m2": 118.6,
"lot_area_m2": 168,
"min_dwellings": 6,
"max_dwellings": 7
},
"semi-detached": {
"gfa_m2": 118.6,
"lot_area_m2": 168,
"min_dwellings": 6,
"max_dwellings": 7
},
"detached": {
"gfa_m2": 118.6,
"lot_area_m2": 168,
"min_dwellings": 6,
"max_dwellings": 7
}
}
},
"apartment": {
"optimalCalculationType": "fsr",
"calculations": {
"fsr": {
"fsr": 8,
"gfa_m2": 9447.4295984684,
"min_dwellings": 97,
"max_dwellings": 108
}
}
},
"subDivision": {
"optimalCalculationType": null,
"calculations": []
}
}
}
}
Retrieves all essential planning information for the property.
Use this endpoint to retrieve below key insights for the property:
Endpoint
POST https://api.archistar.ai/v1/property/planning-essentials
Sample Request Params (in POST Body)
{
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669"
}
Sample Response
{
"result": {
"Property": {
"property_details": {
"lot_identifier": "1//DP816869",
"localities": [],
"property_type": "LOT PARCEL",
"region": "nsw",
"center_lat": "-33.8663933820815",
"center_long": "151.209717032211",
"property_area_m2": "1180.92869980855",
"arr_gnaf_address_detail_pid": [
"GANSW717805464"
]
},
"property_planning_details": {
"zoning": {
"code": "B8 Metropolitan Centre",
"label": "B8 Metropolitan Centre"
},
"overlays": {
"overlay_id": "101304",
"category": "Development Control",
"key": "Local Provisions",
"value": "Miscellaneous"
},
"lga": "COUNCIL OF THE CITY OF SYDNEY",
"has_flood_overlay": false,
"has_bushfire_overlay": false,
"has_infrastructure_overlay": false,
"has_environment_overlay": false,
"has_heritage_overlay": false,
"has_industry_overlay": false,
"arr_notifications_permitted_use": {
"Permitted with consent": [
{
"value": "Centre-based child care facilities; Commercial premises; Community facilities; Educational establishments; Entertainment facilities; Function centres; Information and education facilities; Passenger transport facilities; Recreation facilities (indoor); Registered clubs; Respite day care centres; Restricted premises; Roads; Tourist and visitor accommodation; Any other development not specified in \"Permitted without consent\" or \"Prohibited\""
}
],
"Permitted without consent": [
{
"value": "Nil"
}
],
"Prohibited": [
{
"value": "Nil"
}
]
}
},
"property_analysis": {
"permitted_use_apartment": null,
"permitted_use_duplex": null,
"permitted_use_duplex_rule_message": [
{
"message": "A duplex may be permissible in this zone. Please check with the local council.",
"url": null
}
],
"permitted_use_mixeduse": false,
"permitted_use_townhouse": null
},
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669"
}
}
}
Retrieves all insights for the property.
Use this endpoint to retrieve below key insights for the property:
Endpoint
POST https://api.archistar.ai/v1/property/insights
Sample Request Params (in POST Body)
{
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669"
}
Sample Response
{
"result": {
"Property": {
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669",
"property_details": {
"lot_identifier": "1//DP816869",
"arr_as_locality_guids": [
"SYDNEY"
],
"property_type": "LOT PARCEL",
"region": "nsw",
"center_lat": "-33.8663933820815",
"center_long": "151.209717032211",
"property_area_m2": "1180.92869980855",
"arr_gnaf_address_detail_pid": [
"GANSW710270788",
"GANSW717805669"
]
},
"property_planning_details": {
"zoning": {
"code": "B8",
"label": "B8"
},
"overlays": {
"overlay_id": "101304",
"category": "Development Control",
"key": "Local Provisions",
"value": "Miscellaneous"
},
"lga": "COUNCIL OF THE CITY OF SYDNEY",
"planning_lep_names": [
"Sydney Local Environmental Plan 2012"
],
"has_flood_overlay": false,
"has_bushfire_overlay": false,
"has_infrastructure_overlay": false,
"has_environment_overlay": false,
"has_heritage_overlay": false,
"has_industry_overlay": false,
"planning_max_fsr": "8",
"planning_max_building_height_m": "0",
"planning_min_lot_size_m2": null,
"planning_min_lot_size_multi_dwelling_m2": null,
"planning_min_lot_width_m": null,
"planning_is_heritage": false,
"arr_notifications_permitted_use": {
"Permitted with consent": [
{
"value": "Centre-based child care facilities; Commercial premises; Community facilities; Educational establishments; Entertainment facilities; Function centres; Information and education facilities; Passenger transport facilities; Recreation facilities (indoor); Registered clubs; Respite day care centres; Restricted premises; Roads; Tourist and visitor accommodation; Any other development not specified in \"Permitted without consent\" or \"Prohibited\""
}
],
"Permitted without consent": [
{
"value": "Nil"
}
],
"Prohibited": [
{
"value": "Nil"
}
]
}
},
"property_analysis": {
"permitted_use_apartment": null,
"permitted_use_commercial": null,
"permitted_use_duplex": null,
"permitted_use_duplex_rule_message": [
{
"message": "A duplex may be permissible in this zone. Please check with the local council."
},
{
"url": null
}
],
"permitted_use_mixeduse": null,
"permitted_use_retail": null,
"permitted_use_townhouse": null,
"permitted_use_grannyflat": null
},
}
}
}
Coming soon.
Retrieves matching ids for use in other services.
Use this endpoint to retrieve Property IDs that may be used to query information from other endpoints.
Endpoint
POST https://api.archistar.ai/v1/property/suggest
Sample Request Params (in POST Body)
{
"streetAddress": "1-7 Castlereagh Street",
"suburb": "Sydney",
"postCode": 2000
}
Sample Response
{
"result": {
"propertyID": "eb382c1c-ed44-4515-8f75-88bb162e8669",
"listingAddress": "1 Castlereagh Street, Sydney"
}
}
Coming Soon.
Coming Soon.
Retrieves matching ids for use in other services.
Use this endpoint to retrieve IDs that may be used to query information from other endpoints.
Sample Request
GET https://api.archistar.ai/v1/ping
Sample Response
{
"result": [
{
"Successfully connected to ArchiStar API"
}
]
}