npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

india-location-details

v1.0.0

Published

npm package to fetch data of india location, based on pincode, state name, city name

Downloads

3

Readme

india-location-details

india-location-details package is to get details about Indian locations based on pincode, state name or city name.

Supported Fields

  1. Pincode
  2. RegionName
  3. Taluk
  4. DivisionName
  5. DistrictName
  6. StateName
  7. CircleName
  8. OfficeName
  9. OfficeType
  10. DeliveryStatus
  11. Telephone
  12. Related_suboffice
  13. Related_headoffice
  14. Longitude
  15. Latitude

Parameters

  1. offset [DEFAULT=0]
  2. limit [DEFAULT=100]
  3. Filter, should be one of the below as per the need
    • StateName
    • pincode
    • regionName
  4. requiredFields [DEFAULT= all 15 supporting fields]

Usage

Installation

npm i india-location-details

Generate API key

1. Register yourself on https://data.gov.in/
2. Log in and go to My Profile, you would find generate API key option besides API KEY title.

import package

const InLocation = require("india-location-details");

Fetch state data

InLocation.fetchStateData(offset, limit, stateName, requiredFields, "YOUR_API_KEY").then((result) =>{
    ...
})
.catch((error) => {
    console.log(error);
    ...
})

Fetch pincode data

InLocation.fetchPincodeData(offset, limit, pincode, requiredFields, "YOUR_API_KEY").then((result) =>{
    console.log(result.data);
    ...
})
.catch((error) => {
    console.log(error);
    ...
})

Fetch region data

InLocation.fetchPincodeData(offset, limit, regionName, requiredFields, "YOUR_API_KEY").then((result) =>{
    console.log(result.data);
    ...
})
.catch((error) => {
    console.log(error);
    ...
})

Examples

const InLocation = require("india-location-details");

InLocation.fetchStateData(
  (offset = 0),
  (limit = 10),
  "maharashtra",
  (requiredFields = ["divisionname", "regionname", "pincode"]),
  "YOUR_API_KEY"
)
  .then((result) => {
    console.log(result.data);
  })
  .catch((error) => {
    console.log(error);
  });

InLocation.fetchPincodeData(
  (offset = 0),
  (limit = 10),
  401101,
  (requiredFields = ["divisionname", "regionname", "pincode"]),
  "YOUR_API_KEY"
)
  .then((result) => {
    console.log(result.data);
  })
  .catch((error) => {
    console.log(error);
  });

InLocation.fetchRegionData(
  (offset = 0),
  (limit = 10),
  "mumbai",
  (requiredFields = ["divisionname", "regionname", "pincode"]),
  "YOUR_API_KEY"
)
  .then((result) => {
    console.log(result.data);
  })
  .catch((error) => {
    console.log(error);
  });

Output format

{
  "total": "Total number of records.",
  "limit": "Size of the data/ no. of records",
  "count": "Number of records returned",
  "currentOffset": "Current offset",
  "nextOffset": "Next offset, in case more data is needed",
  "records": "List of records returned"
}

Example:

This example demonstrate data fetched for mumbai region with default requiredFields.

InLocation.fetchRegionData(0, 2, "mumbai", requiredFields, "YOUR_API_KEY").then((result) =>{
    console.log(result.data)
})
.catch((error) => {
    console.log(error)
})

returns:

{
  "total": 1123,
  "limit": '2',
  "count": 2,
  "currentOffset": undefined,
  "nextOffset": 2,
  "records": [
    {
      "officename": 'Antop Hill S.O',
      "pincode": '400037',
      "officetype": 'S.O',
      "deliverystatus": 'Delivery',
      "divisionname": 'Mumbai  East',
      "regionname": 'Mumbai',
      "circlename": 'Maharashtra',
      "taluk": 'Mumbai',
      "districtname": 'Mumbai',
      "statename": 'MAHARASHTRA',
      "telephone": '022-24120290',
      "related_suboffice": 'NA',
      "related_headoffice": 'Dadar H.O',
      "longitude": 'NA',
      "latitude": 'NA'
    },
    {
      "officename": 'B P T Colony S.O',
      "pincode": '400037',
      "officetype": 'S.O',
      "deliverystatus": 'Non-Delivery',
      "divisionname": 'Mumbai  East',
      "regionname": 'Mumbai',
      "circlename": 'Maharashtra',
      "taluk": 'Mumbai',
      "districtname": 'Mumbai',
      "statename": 'MAHARASHTRA',
      "telephone": '022-4100525',
      "related_suboffice": 'NA',
      "related_headoffice": 'Dadar H.O',
      "longitude": 'NA',
      "latitude": 'NA'
    }
  ]
}