{"id":15304844,"url":"https://github.com/sooluh/kodepos","last_synced_at":"2025-04-05T08:04:02.492Z","repository":{"id":41986959,"uuid":"294292100","full_name":"sooluh/kodepos","owner":"sooluh","description":":postbox: Indonesian postal code search API by place name, village or city/regency.","archived":false,"fork":false,"pushed_at":"2024-11-13T01:01:24.000Z","size":2894,"stargazers_count":114,"open_issues_count":1,"forks_count":31,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T17:28:14.139Z","etag":null,"topics":["api","fastify","indonesia","javascript","kode-pos","kodepos","nodejs","postal-code","typescript","vercel"],"latest_commit_sha":null,"homepage":"https://kodepos.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sooluh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"sooluh","custom":["https://saweria.co/sooluh","https://trakteer.id/sooluh"]}},"created_at":"2020-09-10T03:25:02.000Z","updated_at":"2025-03-23T07:25:22.000Z","dependencies_parsed_at":"2024-05-02T04:57:08.824Z","dependency_job_id":"c3d85ffc-8fdc-4a40-a41d-ac3bd54f1dfb","html_url":"https://github.com/sooluh/kodepos","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fkodepos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fkodepos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fkodepos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sooluh%2Fkodepos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sooluh","download_url":"https://codeload.github.com/sooluh/kodepos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305932,"owners_count":20917208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","fastify","indonesia","javascript","kode-pos","kodepos","nodejs","postal-code","typescript","vercel"],"created_at":"2024-10-01T07:58:16.625Z","updated_at":"2025-04-05T08:04:02.460Z","avatar_url":"https://github.com/sooluh.png","language":"TypeScript","funding_links":["https://ko-fi.com/sooluh","https://saweria.co/sooluh","https://trakteer.id/sooluh"],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://s.id/standwithpalestine\"\u003e\u003cimg alt=\"I stand with Palestine\" src=\"https://cdn.jsdelivr.net/gh/Safouene1/support-palestine-banner@master/banner-project.svg\" width=\"100%\" /\u003e\u003c/a\u003e\n\n![@sooluh/kodepos](https://socialify.git.ci/sooluh/kodepos/image?description=1\u0026descriptionEditable=Indonesian%20postal%20code%20search%20API%20by%20place%20name%2C%20village%20or%20city%2Fregency.\u0026font=Jost\u0026forks=1\u0026issues=1\u0026logo=https%3A%2F%2Fcdn.jsdelivr.net%2Fgh%2Fmicrosoft%2Ffluentui-emoji%40main%2Fassets%2FPostbox%2FColor%2Fpostbox_color.svg\u0026name=1\u0026owner=1\u0026pattern=Charlie%20Brown\u0026pulls=1\u0026stargazers=1\u0026theme=Auto)\n\n## Requirements\n\n- Node.js `\u003e= 20.x`\n- npm\n\n## Getting Started\n\n1. Clone this repository\n\n   ```bash\n   git clone https://github.com/sooluh/kodepos.git\n   ```\n\n2. Move to the repository directory\n\n   ```bash\n   cd kodepos\n   ```\n\n3. Install dependencies\n\n   ```bash\n   npm ci\n   ```\n\n4. Run locally\n\n   - Development mode\n\n     ```bash\n     npm run dev\n     ```\n\n   - Production mode\n\n     1. Build first\n\n        ```bash\n        npm run build\n        ```\n\n     2. Start the app\n\n        ```bash\n        npm run start\n        ```\n\n### One-click Deployment\n\nThe fastest way to use it privately on PaaS available\n\n\u003ca href=\"https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos%2Ftree%2Fmain\"\u003e\n  \u003cimg alt=\"Deploy with Vercel\" src=\"https://vercel.com/button\" height=\"32\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://app.koyeb.com/deploy?type=git\u0026repository=github.com/sooluh/kodepos\u0026branch=main\u0026name=kodepos\"\u003e\n  \u003cimg alt=\"Deploy with Koyeb\" src=\"https://www.koyeb.com/static/images/deploy/button.svg\" height=\"32\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://render.com/deploy\"\u003e\n  \u003cimg alt=\"Deploy with Render\" src=\"https://render.com/images/deploy-to-render-button.svg\" height=\"32\" /\u003e\n\u003c/a\u003e\n\n### Open in\n\n\u003ca href=\"https://idx.google.com/import?url=https%3A%2F%2Fgithub.com%2Fsooluh%2Fkodepos\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://cdn.idx.dev/btn/open_light_32.svg\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://cdn.idx.dev/btn/open_dark_32.svg\"\u003e\n    \u003cimg height=\"32\" alt=\"Open in IDX\" src=\"https://cdn.idx.dev/btn/open_purple_32.svg\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003ca href=\"https://gitpod.io/#https://github.com/sooluh/kodepos\"\u003e\n  \u003cimg alt=\"Open in Gitpod\" src=\"https://gitpod.io/button/open-in-gitpod.svg\" height=\"32\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://codespaces.new/sooluh/kodepos\"\u003e\n  \u003cimg alt=\"Open in GitHub Codespaces\" src=\"https://github.com/codespaces/badge.svg\" height=\"32\" /\u003e\n\u003c/a\u003e\n\n## Endpoints\n\n### Search by Place Name\n\n```\n[ENDPOINT] /search\n```\n\n\u003cpre\u003e\n[GET] \u003ca href=\"https://kodepos.vercel.app/search/?q=danasari\"\u003ehttp://localhost:3000/search/?q=danasari\u003c/a\u003e\n\u003c/pre\u003e\n\n#### Query strings\n\n| Params | Description     | Required |\n| ------ | --------------- | :------: |\n| q      | Search keywords |    ✅     |\n\n#### Response\n\n```json\n{\n  \"statusCode\": 200,\n  \"code\": \"OK\",\n  \"data\": [\n    {\n      \"code\": 46386,\n      \"village\": \"Danasari\",\n      \"district\": \"Cisaga\",\n      \"regency\": \"Ciamis\",\n      \"province\": \"Jawa Barat\",\n      \"latitude\": -7.3271342,\n      \"longitude\": 108.4577572,\n      \"elevation\": 110,\n      \"timezone\": \"WIB\"\n    },\n    {\n      \"code\": 53357,\n      \"village\": \"Danasari\",\n      \"district\": \"Karangjambu\",\n      \"regency\": \"Purbalingga\",\n      \"province\": \"Jawa Tengah\",\n      \"latitude\": -7.1857161,\n      \"longitude\": 109.4368274,\n      \"elevation\": 705,\n      \"timezone\": \"WIB\"\n    },\n    {\n      \"code\": 52314,\n      \"village\": \"Danasari\",\n      \"district\": \"Pemalang\",\n      \"regency\": \"Pemalang\",\n      \"province\": \"Jawa Tengah\",\n      \"latitude\": -6.8649882,\n      \"longitude\": 109.3956117,\n      \"elevation\": 6,\n      \"timezone\": \"WIB\"\n    },\n    {\n      \"code\": 52465,\n      \"village\": \"Danasari\",\n      \"district\": \"Bojong\",\n      \"regency\": \"Tegal\",\n      \"province\": \"Jawa Tengah\",\n      \"latitude\": -7.1153626,\n      \"longitude\": 109.1850778,\n      \"elevation\": 737,\n      \"timezone\": \"WIB\"\n    }\n  ]\n}\n```\n\n### Search by Coordinates\n\n```\n[ENDPOINT] /detect\n```\n\n\u003cpre\u003e\n[GET] \u003ca href=\"https://kodepos.vercel.app/detect/?latitude=-6.547052\u0026longitude=107.3980201\"\u003ehttp://localhost:3000/detect/?latitude=-6.547052\u0026longitude=107.3980201\u003c/a\u003e\n\u003c/pre\u003e\n\n#### Query strings\n\n| Params    | Description        | Required |\n| --------- | ------------------ | :------: |\n| latitude  | Location latitude  |    ✅     |\n| longitude | Location longitude |    ✅     |\n\n#### Response\n\n```json\n{\n  \"statusCode\": 200,\n  \"code\": \"OK\",\n  \"data\": {\n    \"code\": 41152,\n    \"village\": \"Kembangkuning\",\n    \"district\": \"Jatiluhur\",\n    \"regency\": \"Purwakarta\",\n    \"province\": \"Jawa Barat\",\n    \"latitude\": -6.5495591,\n    \"longitude\": 107.4121855,\n    \"elevation\": 112,\n    \"timezone\": \"WIB\",\n    \"distance\": 1.5894826841413479\n  }\n}\n```\n\n### Showcase\n\nList of awesome projects powered by this API\n\n- [**kodepos-web**](https://github.com/dotslashf/kodepos-web)\u003cbr\u003e\n  Simple web-app for postcode search by [dotslashf](https://github.com/dotslashf)\n\n- [**Kode POS**](https://github.com/AzharRivaldi/Kode-POS-Indonesia)\u003cbr\u003e\n  Indonesia postal code search application (kotlin) by [AzharRivaldi](https://github.com/AzharRivaldi)\n\n### Ready to use!\n\nList of server APIs ready to use publicly\n\n\u003e [!IMPORTANT]\n\u003e 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!\n\n- [https://kodepos.vercel.app](https://kodepos.vercel.app/search/?q=danasari) `latest`\n- [https://kodepos.onrender.com](https://kodepos.onrender.com/search/?q=danasari) `latest`\n\n### License\n\nThis project is licensed under [Apache 2.0 License](https://github.com/sooluh/kodepos/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsooluh%2Fkodepos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsooluh%2Fkodepos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsooluh%2Fkodepos/lists"}