irfanmauuu / kodepos

:postbox: Indonesian postal code search API by place name, village or city.

Getting Started

1. Clone this repository

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

2. Change the current directory to this repository folder

   cd kodepos

3. Install dependencies

   yarn install

4. Run the app! (locally)

   • Development mode

     yarn dev

   • Production mode

     1. Build first

        yarn build

     2. Start the app

        yarn start

One-click Deployment

The fastest way to use it privately on PaaS available

Basic Usage

Base URL : http://localhost:5000

Endpoint	Description	Parameter	Method
/search	To find postcode using keywords	q	GET

Example of Use

Request

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

Response

{
  "success": true,
  "message": "Data search successfully parsed.",
  "data": [
    {
      "province": "Jawa Tengah",
      "city": "Purbalingga",
      "subdistrict": "Karangjambu",
      "urban": "Danasari",
      "postalcode": "53357"
    },
    {
      "province": "Jawa Tengah",
      "city": "Tegal",
      "subdistrict": "Bojong",
      "urban": "Danasari",
      "postalcode": "52465"
    },
    {
      "province": "Jawa Tengah",
      "city": "Pemalang",
      "subdistrict": "Pemalang",
      "urban": "Danasari",
      "postalcode": "52314"
    },
    {
      "province": "Jawa Barat",
      "city": "Ciamis",
      "subdistrict": "Cisaga",
      "urban": "Danasari",
      "postalcode": "46386"
    }
  ]
}

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

• https://kodepos.vercel.app/
• https://kodepos.herokuapp.com/

License

Code licensed under Apache 2.0 License.