Home

Awesome

<h1 align="">Indonesian Area API</h1> <p> <a href="https://nestjs.com"><img alt="NestJS" src="https://img.shields.io/badge/-NestJS-ea2845?style=flat-square&logo=nestjs&logoColor=white" /></a> <a href="https://www.typescriptlang.org"><img alt="TypeScript" src="https://img.shields.io/badge/-TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white" /></a> <a href="https://www.prisma.io"><img alt="Prisma" src="https://img.shields.io/badge/-Prisma-1B222D?style=flat-square&logo=prisma&logoColor=white" /></a> <a href="https://www.mongodb.com"><img alt="MongoDB" src="https://img.shields.io/badge/-MongoDB-47A248?style=flat-square&logo=mongodb&logoColor=white" /></a> <a href="https://www.postgresql.org"><img alt="PostgreSQL" src="https://img.shields.io/badge/-PostgreSQL-657991?style=flat-square&logo=postgresql&logoColor=white" /></a> <a href="https://www.mysql.com"><img alt="MySQL" src="https://img.shields.io/badge/-MySQL-00688F?style=flat-square&logo=mysql&logoColor=white" /></a> </p>

English | हिन्दी | Bahasa Indonesia | 한국어 | Tagalog

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.

Note!

If you choose MongoDB as the database provider, the id property will be added to the response. See issue #308.

This id property is not present if you use another database providers.

Getting Started

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

Deploy on Railway

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 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

Give a ⭐️ if this project helped you!

Also please consider supporting this project with a donation. Your donation will help us maintain and develop this project and provide you with better support.