Ciencuadras Autocomplete API finds cities, localities and neighborhoods by name. Each item has a type, the names and the number of listings, plus a search object with the ready values for the department, city, locality and neighborhood filters of the search route. A query without a match returns an empty list. Failed requests are not 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.
2 optional filters available.
string
Required
Place name, 2 to 100 characters, for example medellin.
coffee shops
string
Optional
sale (default) or rent. Used for the listing counts.
example
integer
Optional
Number of results, 1 to 20. Default 7.
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": {
"items": [
{
"id": 6,
"city": "Bogot\u00e1",
"name": "Chapinero",
"type": "locality",
"search": {
"city": "bogota",
"locality": "chapinero",
"department": "cundinamarca"
},
"locality": "Chapinero",
"department": "Cundinamarca",
"neighborhood": null,
"total_listings": 3356
},
{
"id": 3974,
"city": "Bogot\u00e1",
"name": "Chapinero Central",
"type": null,
"search": {
"city": "bogota",
"locality": "chapinero",
"department": "cundinamarca",
"neighborhood": "chapinero-central"
},
"locality": "Chapinero",
"department": "Cundinamarca",
"neighborhood": "Chapinero Central",
"total_listings": 187
},
{
"id": 4280,
"city": "Bogot\u00e1",
"name": "Chapinero Central",
"type": null,
"search": {
"city": "bogota",
"locality": "chapinero",
"department": "cundinamarca",
"neighborhood": "chapinero-central"
},
"locality": "Chapinero",
"department": "Cundinamarca",
"neighborhood": "Chapinero Central",
"total_listings": 187
},
{
"id": 4295,
"city": "Bogot\u00e1",
"name": "Chapinero Central",
"type": null,
"search": {
"city": "bogota",
"locality": "chapinero",
"department": "cundinamarca",
"neighborhood": "chapinero-central"
},
"locality": "Chapinero",
"department": "Cundinamarca",
"neighborhood": "Chapinero Central",
"total_listings": 187
},
{
"id": 1480,
"city": "Bogot\u00e1",
"name": "Chapinero Central",
"type": "neighborhood",
"search": {
"city": "bogota",
"locality": "chapinero",
"department": "cundinamarca",
"neighborhood": "chapinero-central"
},
"locality": "Chapinero",
"department": "Cundinamarca",
"neighborhood": "Chapinero Central",
"total_listings": 170
}
],
"query": "chapin"
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or invalid. This response is not billable.
{
"errors": {
"transaction": [
"The transaction field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
Ciencuadras 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": "Ciencuadras 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.