🇻🇳 Vietnam Geographic API

Complete API for Vietnamese provinces, cities, and administrative divisions

API Endpoints

GET/api/provinces

Get all provinces/cities

Parameters: search, type, isCentral

Example:/api/provinces?search=hà&type=city

GET/api/provinces/[code]

Get specific province with all wards

Parameters: code (province code or slug)

Example:/api/provinces/01

GET/api/wards

Search wards/communes

Parameters: search, type, provinceCode, limit

Example:/api/wards?search=ba đình&limit=10

GET/api/search

Universal search (provinces + wards)

Parameters: q, type, limit

Example:/api/search?q=hà nội&limit=5

GET/api/stats

Get statistics about the data

Parameters: none

Example:/api/stats

API Tester

Data Structure

Province/City

{
  "code": "01",
  "name": "Hà Nội",
  "slug": "ha-noi",
  "type": "city", // or "province"
  "isCentral": true,
  "fullName": "Thành phố Hà Nội",
  "wards": [...] // Array of wards/communes
}

Ward/Commune

{
  "code": "00013",
  "name": "Hà Đông",
  "fullName": "Phường Hà Đông, Thành phố Hà Nội",
  "slug": "ha-dong",
  "type": "ward" // or "commune"
}