/idn-area

API that provides information about Indonesia administrative area, based on the latest official data 🇮🇩

Primary LanguageTypeScriptMIT LicenseMIT

Indonesian Area API (API Wilayah Indonesia)

NestJS TypeScript Prisma MongoDB PostgreSQL MySQL

API that provides information on the administrative areas of Indonesia, from the province, regency, district, to village levels. It also provides island data since version 1.1.0.

Built with NestJS framework and writen in TypeScript. Prisma is used as the ORM to interact with any kind of databases (MySQL, PostgreSQL, and MongoDB).

⚠️ Upgrading to v3.0.0 ⚠️

Since v3.0.0, Node.js v18 or higher is required.

Table of Content


Getting Started

Please read the installation guide to install and run this app.

Data

The data we used is based on official sources, managed in idn-area-data repository and distributed as a npm package.

The data is made available here under the Open Database License (ODbL).

Documentation

Read the latest version of API documentation in the documentation page. This documentation is automatically generated using @nestjs/swagger.

You also can access the documentation in your local machine by running the app (see Getting Started) and open http://localhost:3000/docs in your browser.

Live Demo

You can try the API by replacing the http://localhost:3000 with the endpoint provided in this repository description.

These are some sample projects that using this API :

Contributing

If you want to contribute to this project, please read the CONTRIBUTING.md file and make sure you follow the Pull Request guide

Problem Reporting

We have different channels for each problem, please use them by following these conditions :

Reporting a Bug

To report a bug, please open a new issue following the guide.

Requesting a New Feature

If you have a new feature in mind, please open a new issue following the guide.

Asking a Question

If you have a question, you can search for answers in the GitHub Discussions Q&A category. If you don't find a relevant discussion already, you can open a new discussion.

Support This Project

Trakteer Saya

You can support this project by donating via GitHub Sponsor, Trakteer, or Saweria.