GET /v1/admin-boundaries
Vietnam provincial and ward/district polygons in GeoJSON or WKT.
Returns Vietnam administrative boundary polygons (level 4 provinces/cities and level 8 wards/communes/districts) as GeoJSON or WKT, along with optional population, area, centroid, and pre-merge administrative metadata.
Required scope: admin_boundaries:read
Request
Query parameters
| Name | Required | Description |
|---|---|---|
levels | no | Comma-separated admin levels (4 for province, 8 for ward/district). Default 4,8. |
format | no | Geometry format: geojson (default) or wkt. |
countryCode | no | ISO alpha-2 country code. Default VN. |
tolerance | no | PostGIS ST_SimplifyPreserveTopology tolerance in degrees (e.g. 0.001–0.01) to reduce payload size. |
Response
Response fields
| Field | Type | Description |
|---|---|---|
admin_level_4 / admin_level_8 | array | Requested boundary arrays keyed by level. |
[].name | string | Official boundary name. |
[].province_name | string | null | Parent province name (present on level 8 units). |
[].population | number | null | Population count if available. |
[].area_km2 | number | null | Area in square kilometers if available. |
[].pre_merge_info | object | null | Pre-merger administrative reference metadata if applicable. |
[].admin_center | object | null | { lat, lon } of the administrative center. |
[].centroid | object | null | { lat, lon } geometric centroid. |
[].boundary | object | string | GeoJSON geometry object or WKT string depending on format. |
Common errors
400 BAD_REQUEST— invalidlevels,format, ortolerance.401 INVALID_API_KEY— key not recognized.403 INSUFFICIENT_SCOPE— key is missingadmin_boundaries:read.429 RATE_LIMIT_MINUTE— back off using theretry_afterfield.