Wilayah Indonesia

A CLI tool to manage and transform Indonesian administrative data from BPS (Badan Pusat Statistik) API.

Description

This tool helps you fetch the latest Indonesian administrative division data (provinces, regencies, districts, subdistricts and postal codes) from the official BPS API and transform it into a clean, relational format suitable for applications.

Features

• 🌏 Fetch complete Indonesian administrative data from BPS API
• 🔄 Transform raw data into structured relational format
• 📁 Organized data structure with both raw and transformed versions
• 🎯 CLI interface with simple commands
• ⚡ Concurrent API requests with rate limiting

Installation

npm install -g @ibnumardini/wilayah-indonesia

Or run directly with npx:

npx @ibnumardini/wilayah-indonesia

Usage

Type of Transform

1. json (Javascript Object Notation)
2. csv (Comma Separated Values)
3. sql (Structured Query Language)

Fetch Latest Data

Fetch the latest administrative data from BPS API:

wilayah-indonesia --fetch
# or
wilayah-indonesia -f

Transform Data

Transform raw data into relational format (replace type):

wilayah-indonesia --transform <type>
# or
wilayah-indonesia -t <type>

Fetch and Transform

You can combine both operations:

wilayah-indonesia --fetch --transform <type>

Project Structure

├── data/
│   ├── raw/                    # Raw data from BPS API
│   │   ├── 1-provinces.json
│   │   ├── 2-regencies.json
│   │   ├── 3-districts.json
│   │   ├── 4-subdistricts.json
│   │   └── 5-postcodes.json
│   └── transformed/            # Cleaned and structured data
│       ├── json/
│       │   └── *.json
│       ├── csv/
│       │   └── *.csv
│       └── sql/
│           └── *.sql
├── src/
│   ├── index.js               # Main CLI entry point
│   ├── fetch-data.js          # BPS API data fetching
│   ├── transform-data.js      # Data transformation logic
│   └── helper/
│       ├── file.js           # File operations utilities
│       ├── sql.js            # SQL tranformation utilities
│       ├── logger.js         # Logging utilities
│       └── string.js         # String manipulation utilities
└── package.json

Data Format

Raw Data

Raw data maintains the original structure from BPS API with fields like kode_bps and nama_bps.

Transformed Data

The transformed data provides a cleaner structure:

Provinces:

{
  "code": "11",
  "name": "Aceh"
}

Regencies:

{
  "code": "1101",
  "name": "Simeulue",
  "province_code": "11"
}

Districts:

{
  "code": "1101010",
  "name": "Teupah Selatan",
  "regency_code": "1101"
}

Subdistricts:

{
  "code": "1101010001",
  "name": "Latiung",
  "district_code": "1101010"
}

Postal Codes:

{
  "code": "23891",
  "name": "Latiung",
  "subdistrict_code": "1101010001"
}

Development

Prerequisites

• Node.js (version 14 or higher)
• pnpm (recommended) or npm

Setup

1. Clone the repository:

   git clone <repository-url>
   cd wilayah-indonesia

2. Install dependencies:

   pnpm install

3. Run development commands:

   # Fetch data only
   pnpm run fetch-data
   
   # Transform data only
   pnpm run transform-data

Dependencies

• commander: CLI framework for building command-line tools
• p-limit: Concurrency control for API requests

Data Source

This tool fetches data from the official Indonesian Bureau of Statistics (BPS) API, ensuring you get the most up-to-date administrative division information.

License

Apache-2.0

Author

Muhammad Fatkurozi <[email protected]>

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.