Imovelweb Polygon API returns the GeoJSON outline (MultiPolygon, longitude then latitude) of a neighborhood, city or state. Use it to draw a search area on a map. Pass a location id from the autocomplete route. An unknown id returns 404 and is 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.
string
Required
Location id from the autocomplete route. Example: V1-Z-52.
Austin, Texas
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"type": "zone",
"geometry": {
"type": "MultiPolygon",
"coordinates": [
[
[
[
-46.69113979499997,
-23.546079476999974
],
[
-46.68939270299995,
-23.547561754999947
],
[
-46.682607287999986,
-23.553396801999952
]
]
]
]
},
"location": "V1-Z-52"
},
"meta": {
"billable": true,
"endpoint_family": "polygon"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or outside its allowed values. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Not Found
The location has no outline. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "polygon"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found."
},
"success": false
}Upstream Unavailable
Imovelweb could not be reached, or returned data that does not match the expected shape. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "polygon"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Imovelweb 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.