Vietnam Administrative Units API

Overview

This package provides a simple way to fetch and manipulate administrative units in Vietnam, including provinces, districts, and wards.

• Note: work only on nodejs, not for browser environment

Installation

pnpm install vn-units

Usage

Importing the package

import { getProvinces, getDistricts, getWards } from "vn-units";

Fetching Provinces

getProvinces({ normalizeVietnamese: true }).then((provinces) => {
  console.log(provinces);
});

Options:

• date (optional): Fetch data as of a specific date.
• normalizeVietnamese (optional, default: false): Convert names to non-accented Vietnamese.

Fetching Districts

getDistricts({ provinceCode: "01", normalizeVietnamese: true }).then(
  (districts) => {
    console.log(districts);
  }
);

Options:

• date (optional)
• provinceCode (optional): Filter districts by province.
• normalizeVietnamese (optional, default: false)

Fetching Wards

getWards({
  provinceCode: "01",
  districtCode: "001",
  normalizeVietnamese: true,
}).then((wards) => {
  console.log(wards);
});

Options:

• date (optional)
• provinceCode (optional)
• districtCode (optional)
• normalizeVietnamese (optional, default: false)

License

MIT