Package Exports

pincode-address
pincode-address/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pincode-address) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📦 pincode-address

Fetch Indian location details using a 6-digit PIN code via India Post's public API.

🌐 Description

pincode-address is a lightweight Node.js module that uses India Post’s public API to fetch detailed address information such as post office name, district, state, and region, based on the provided PIN code.

🚀 Installation

npm install pincode-address

📚 Usage

const { getPincodeInfo } = require('pincode-address');

(async () => {
  const info = await getPincodeInfo('302022');
  console.log(info);
})();

✅ Output:

[
  {
    "Name": "Bilwa",
    "Description": null,
    "BranchType": "Branch Post Office",
    "DeliveryStatus": "Delivery",
    "Circle": "Rajasthan",
    "District": "Jaipur",
    "Division": "Jaipur City",
    "Region": "Jaipur HQ",
    "Block": "Sanganer",
    "State": "Rajasthan",
    "Country": "India",
    "Pincode": "302022"
  },
  {
    "Name": "Shri Ram Ki Nangal",
    "Description": null,
    "BranchType": "Branch Post Office",
    "DeliveryStatus": "Delivery",
    "Circle": "Rajasthan",
    "District": "Jaipur",
    "Division": "Jaipur City",
    "Region": "Jaipur HQ",
    "Block": "Jaipur",
    "State": "Rajasthan",
    "Country": "India",
    "Pincode": "302022"
  },
  {
    "Name": "Sitapura Industrial Area",
    "Description": null,
    "BranchType": "Sub Post Office",
    "DeliveryStatus": "Delivery",
    "Circle": "Rajasthan",
    "District": "Jaipur",
    "Division": "Jaipur City",
    "Region": "Jaipur HQ",
    "Block": "Jaipur",
    "State": "Rajasthan",
    "Country": "India",
    "Pincode": "302022"
  }
]

🧪 Input Validation

The input must be a 6-digit Indian PIN code, otherwise an error is thrown.

await getPincodeInfo("123"); // ❌ Error: Invalid PIN code. It must be 6 digits.

📦 API Reference

`getPincodeInfo(pincode: string): Promise<PostOffice[] | null>`

pincode - a valid 6-digit string
returns - an array of post office objects or null if not found

📄 License

MIT

👤 Author

Roshan Suthar
GitHub: Roshansuthar1105

🛠️ Contributing

Pull requests are welcome. For major changes, open an issue first to discuss what you would like to change.

🐛 Issues

If you encounter any issues or bugs, please report them here.