PropertyGuru Autocomplete API turns search text into districts, areas, neighbourhoods, MRT and LRT stations and projects. Each result has an id, type, display text, description, district and coordinates when known. Districts in Singapore and areas and regions in Malaysia also carry a ready search_filter you can pass to the Search API. An empty list is a successful, billable response.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
1 optional filter available.
string
Required
Market to search: sg (Singapore) or my (Malaysia). Example: sg.
US
string
Required
Search text, 2 to 100 characters. Example: orchard.
coffee shops
integer
Optional
Number of results, 1 to 20 (default 8). Example: 5.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "orchard",
"market": "sg",
"results": [
{
"id": "D09",
"text": "D09 Orchard / River Valley",
"type": "DISTRICT",
"district": "D09",
"latitude": null,
"longitude": null,
"type_label": "District",
"description": "D9",
"search_filter": {
"district_code": "D09"
}
},
{
"id": "8197",
"text": "TE14 Orchard MRT Station",
"type": "MRT_STATION",
"district": "D09",
"latitude": 1.30407,
"longitude": 103.83226,
"type_label": "MRT Station",
"description": "301 Orchard Boulevard, 237974",
"search_filter": null
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required parameter or a range is invalid. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
PropertyGuru could not be reached or returned data that does not match the request. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "PropertyGuru could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.