GitHub - sooluh/kodepos: :postbox: Indonesian postal code search API by place name, village or city/regency.

Requirements

Node.js >= 20.x
npm

Getting Started

Clone this repository

git clone https://github.com/sooluh/kodepos.git

Move to the repository directory
```
cd kodepos
```
Install dependencies
```
npm ci
```
Run locally
- Development mode
```
npm run dev
```
- Production mode
  1. Build first
```
npm run build
```
  2. Start the app
```
npm run start
```

One-click Deployment

The fastest way to use it privately on PaaS available

Endpoints

Search by Place Name

[ENDPOINT] /search

[GET] http://localhost:3000/search/?q=danasari

Query strings

Params	Description	Required
q	keywords	[x]

Search by Coordinates

[ENDPOINT] /detect

[GET] http://localhost:3000/detect/?latitude=-6.547052&longitude=107.3980201

Query strings

Params	Description	Required
latitude	-	[x]
longitude	-	[x]

Basic Usage

Request

curl -XGET 'http://localhost:3000/search/?q=danasari'

Response

{
  "statusCode": 200,
  "code": "OK",
  "data": [
    {
      "code": 46386,
      "village": "Danasari",
      "district": "Cisaga",
      "regency": "Ciamis",
      "province": "Jawa Barat",
      "latitude": -7.3271342,
      "longitude": 108.4577572,
      "elevation": 110,
      "timezone": "WIB"
    },
    {
      "code": 53357,
      "village": "Danasari",
      "district": "Karangjambu",
      "regency": "Purbalingga",
      "province": "Jawa Tengah",
      "latitude": -7.1857161,
      "longitude": 109.4368274,
      "elevation": 705,
      "timezone": "WIB"
    },
    {
      "code": 52314,
      "village": "Danasari",
      "district": "Pemalang",
      "regency": "Pemalang",
      "province": "Jawa Tengah",
      "latitude": -6.8649882,
      "longitude": 109.3956117,
      "elevation": 6,
      "timezone": "WIB"
    },
    {
      "code": 52465,
      "village": "Danasari",
      "district": "Bojong",
      "regency": "Tegal",
      "province": "Jawa Tengah",
      "latitude": -7.1153626,
      "longitude": 109.1850778,
      "elevation": 737,
      "timezone": "WIB"
    }
  ]
}

Showcase

List of awesome projects powered by this API

kodepos-web
Simple web-app for postcode search by dotslashf
Kode POS
Indonesia postal code search application (kotlin) by AzharRivaldi

Ready to use!

List of server APIs ready to use publicly

Important

For production usage, we recommend deploying it on your own and not using the list below. The list below can be used for development or learning purposes only!

https://kodepos.vercel.app latest
https://kodepos.onrender.com latest

License

This project is licensed under Apache 2.0 License.

Name		Name	Last commit message	Last commit date
Latest commit History 97 Commits
.github		.github
app		app
bin		bin
data		data
start		start
types		types
.editorconfig		.editorconfig
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json
vercel.json		vercel.json

License

sooluh/kodepos

Folders and files

Latest commit

History

Repository files navigation

Requirements

Getting Started

One-click Deployment

Endpoints

Search by Place Name

Query strings

Search by Coordinates

Query strings

Basic Usage

Request

Response

Showcase

Ready to use!

License

About

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Languages