{"id":29014027,"url":"https://github.com/integeralex/indiapincodefinder","last_synced_at":"2026-01-20T17:31:01.004Z","repository":{"id":297591590,"uuid":"997254942","full_name":"IntegerAlex/IndiaPincodeFinder","owner":"IntegerAlex","description":"IndiaPincodeFinder is a versatile module that helps you find detailed Indian address information by using a valid 6-digit PIN code.","archived":false,"fork":false,"pushed_at":"2025-06-20T10:39:50.000Z","size":1025,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-22T23:48:52.590Z","etag":null,"topics":["india","nodejs","npm-package","pincode","pincode-finder","pypi-package","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntegerAlex.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,"zenodo":null}},"created_at":"2025-06-06T08:05:28.000Z","updated_at":"2025-06-20T10:39:54.000Z","dependencies_parsed_at":"2025-06-06T09:36:26.998Z","dependency_job_id":"7dd61d3e-9fd8-4a03-b82d-5a325455869a","html_url":"https://github.com/IntegerAlex/IndiaPincodeFinder","commit_stats":null,"previous_names":["integeralex/indiapincodefinder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/IntegerAlex/IndiaPincodeFinder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2FIndiaPincodeFinder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2FIndiaPincodeFinder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2FIndiaPincodeFinder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2FIndiaPincodeFinder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntegerAlex","download_url":"https://codeload.github.com/IntegerAlex/IndiaPincodeFinder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntegerAlex%2FIndiaPincodeFinder/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261945404,"owners_count":23234243,"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":["india","nodejs","npm-package","pincode","pincode-finder","pypi-package","python"],"created_at":"2025-06-25T20:12:37.856Z","updated_at":"2026-01-20T17:31:00.889Z","avatar_url":"https://github.com/IntegerAlex.png","language":"Python","readme":"# 🇮🇳 IndiaPincodeFinder\n[![PyPI Downloads](https://static.pepy.tech/badge/indiapincodefinder)](https://pepy.tech/projects/indiapincodefinder)\n![NPM Downloads](https://img.shields.io/npm/dt/india-pincode-finder?style=plastic\u0026logo=npm)\n\n**IndiaPincodeFinder** is a versatile module available in both **Python** and **JavaScript (Node.js)** that helps you **find detailed Indian address information by using a valid 6-digit PIN code**. It's ideal for use in logistics, address validation, fintech onboarding (KYC), e-commerce, and mapping services.\n\n---\n\n## 📦 Features\n\n- 🔎 Lookup addresses by PIN code (Postal Index Number)\n- 🧾 Returns location metadata: state, district, taluka.\n- ⚡ Fast lookup with offline JSON dataset (no API call needed)\n- 🧩 Plug-and-play for both Python and Node.js applications\n\n---\n\n## Python Package\n\n### 🚀 Installation (Python)\n\nInstall via `pip`:\n\n```bash\npip install indiapincodefinder\n```\n\n### 📖 Usage (Python)\n\n```python\nimport indiapincodefinder\n\n# Get address by Pincode\naddress = indiapincodefinder.pin_to_address(pincode=400001)\n\n# Get state by Pincode\nstate = indiapincodefinder.pin_to_state(pincode=400001)\n\n# Get district by Pincode\ndistrict = indiapincodefinder.pin_to_district(pincode=400001)\n\n# Get taluka by Pincode\ntaluka = indiapincodefinder.pin_to_taluka(pincode=400001)\n\n```\n\n---\n\n## JavaScript Package (Node.js)\n\n### 🚀 Installation (JavaScript)\n\nInstall via `npm`:\n\n```bash\nnpm install india-pincode-finder\n```\n\n### 📖 Usage (JavaScript)\n\n```javascript\n// CommonJS\nconst { \n  pinToAddress, \n  pinToState, \n  pinToDistrict, \n  pinToTaluka,\n  clearCache\n} = require('india-pincode-finder');\n\n// ES Modules\nimport { \n  pinToAddress, \n  pinToState, \n  pinToDistrict, \n  pinToTaluka,\n  clearCache\n} from 'india-pincode-finder';\n\n// Get the full address details for a pincode\nconsole.log(pinToAddress(411001));\n// Output: { district: 'Pune', block: 'Pune City', state: 'Maharashtra' }\n\n// Get the state for a pincode\nconsole.log(pinToState(411001));\n// Output: 'Maharashtra'\n\n// Get the district for a pincode\nconsole.log(pinToDistrict(411001));\n// Output: 'Pune'\n\n// Get the taluka/block for a pincode\nconsole.log(pinToTaluka(411001));\n// Output: 'Pune City'\n\n// Clear the cache (useful if your application needs to refresh data)\nclearCache();\n```\n\n### API (JavaScript)\n\n### pinToAddress(pincode: number): object | null\n\nGet full address details for a pincode.\n\n- **pincode**: 6-digit PIN code (number)\n- **Returns**: \n  - `object`: An object like `{ district: string; block: string; state: string; }` if found.\n  - `null`: If no data is found for the given pincode.\n\n### pinToState(pincode: number): string | null\n\nGet state for a pincode.\n\n- **pincode**: 6-digit PIN code (number)\n- **Returns**: \n  - `string`: The name of the state if found.\n  - `null`: If no data is found for the given pincode.\n\n### pinToDistrict(pincode: number): string | null\n\nGet district for a pincode.\n\n- **pincode**: 6-digit PIN code (number)\n- **Returns**: \n  - `string`: The name of the district if found.\n  - `null`: If no data is found for the given pincode.\n\n### pinToTaluka(pincode: number): string | null\n\nGet taluka/block for a pincode.\n\n- **pincode**: 6-digit PIN code (number)\n- **Returns**: \n  - `string`: The name of the taluka/block if found.\n  - `null`: If no data is found for the given pincode.\n\n### clearCache(): void\n\nClears both the in-memory and disk cache.\n\n- **Returns**: Nothing (void)\n- **Use case**: Call this method if you want to force a fresh load of data from the source JSON file\n\n### Caching Mechanism (JavaScript)\n\nThe package uses a two-level caching strategy for optimal performance:\n\n1. **In-memory cache**: Provides the fastest access for frequently used data\n2. **Disk cache**: Persists between application runs, improving startup performance\n\nThe cache is automatically invalidated when the source data file is modified.\n\n## 📄 License\n\nThis project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.\n\nFor commercial use without GPL compliance, please contact the authors for licensing options.\n\n## Copyright\n\n[@IntegerAlex](https://github.com/IntegerAlex)\n[@AniketDhumal](https://github.com/Aniket-Dhumal)\n\n## 📄 Disclaimer\n\nThis project is for educational purposes only. The data is sourced from public databases.\n\n## 📄 Contact\n\nFor any questions or feedback, please contact [@IntegerAlex](mailto:inquiry.akshatkotpalliwar@gmail.com) or [@AniketDhumal](mailto:anikethd1410@gmail.com).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintegeralex%2Findiapincodefinder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintegeralex%2Findiapincodefinder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintegeralex%2Findiapincodefinder/lists"}