india-location-details
v1.0.0
Published
npm package to fetch data of india location, based on pincode, state name, city name
Downloads
3
Maintainers
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
- Pincode
- RegionName
- Taluk
- DivisionName
- DistrictName
- StateName
- CircleName
- OfficeName
- OfficeType
- DeliveryStatus
- Telephone
- Related_suboffice
- Related_headoffice
- Longitude
- Latitude
Parameters
- offset [DEFAULT=0]
- limit [DEFAULT=100]
- Filter, should be one of the below as per the need
- StateName
- pincode
- regionName
- 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'
}
]
}