Properati Autocomplete API turns a place name into the location ids that the search route takes. Each result has an id, the place name, its kind and the parent area (the department for a city).
Good to know:
- Colombia only. The text must have 3 to 100 characters. Shorter text returns a validation error.
- A text with no match returns an empty list and is billed as a normal answer.
- Answers are kept for one hour.
- Failures are never billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
Place name to look up, 3 to 100 characters. Example: Medellin.
coffee shops
integer
Optional
Number of results, 1 to 25 (default 10).
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": "Medellin",
"returned": 1,
"locations": [
{
"id": "3674954",
"kind": "geo",
"text": "Medell\u00edn",
"group": "Areas",
"parent": "Antioquia"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
The text is shorter than 3 characters or the limit is out of range. This response is not billable.
{
"errors": {
"q": [
"The q field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Properati could not be reached, or returned a page that does not match the expected shape. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Properati 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.