India Pincode Finder

A Node.js module 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.

Installation

1npm install india-pincode-finder

Usage

1// CommonJS
2const { 
3  pinToAddress, 
4  pinToState, 
5  pinToDistrict, 
6  pinToTaluka 
7} = require('india-pincode-finder');
8
9// ES Modules
10import { 
11  pinToAddress, 
12  pinToState, 
13  pinToDistrict, 
14  pinToTaluka 
15} from 'india-pincode-finder';
16
17// Get the full address details for a pincode
18console.log(pinToAddress(411001));
19// Output: { district: 'Pune', block: 'Pune City', state: 'Maharashtra' }
20
21// Get the state for a pincode
22console.log(pinToState(411001));
23// Output: 'Maharashtra'
24
25// Get the district for a pincode
26console.log(pinToDistrict(411001));
27// Output: 'Pune'
28
29// Get the taluka/block for a pincode
30console.log(pinToTaluka(411001));
31// Output: 'Pune City'

API

pinToAddress(pincode: number): object | null

Get full address details for a pincode.

• pincode: 6-digit PIN code (number)
• Throws: Error if the pincode is not a valid 6-digit number.
• Returns:
  • object: An object like { district: string; block: string; state: string; } if found.
  • null: If no data is found for the given pincode.

pinToState(pincode: number): string | null

Get state for a pincode.

• pincode: 6-digit PIN code (number)
• Throws: Error if the pincode is not a valid 6-digit number.
• Returns:
  • string: The name of the state if found.
  • null: If no data is found for the given pincode.

pinToDistrict(pincode: number): string | null

Get district for a pincode.

• pincode: 6-digit PIN code (number)
• Throws: Error if the pincode is not a valid 6-digit number.
• Returns:
  • string: The name of the district if found.
  • null: If no data is found for the given pincode.

pinToTaluka(pincode: number): string | null

Get taluka/block for a pincode.

• pincode: 6-digit PIN code (number)
• Throws: Error if the pincode is not a valid 6-digit number.
• Returns:
  • string: The name of the taluka/block if found.
  • null: If no data is found for the given pincode.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

For commercial use without GPL compliance, please contact the authors for licensing options.