# indian-post

> Postal PIN Code API allows developers to get details of Post Office by searching Postal PIN Code

Latest version **1.2.1** (published 2020-04-25) · 0 weekly downloads

## Install

```sh
npm install indian-post
pnpm add indian-post
yarn add indian-post
bun add indian-post
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-04-25 |
| First published | 2019-10-01 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rahul Shinde |
| Maintainers | rahul5140 |

## Links

- npm: https://www.npmjs.com/package/indian-post
- npm.io page: https://npm.io/package/indian-post

## Recent versions

- 1.2.1 (latest) — 2020-04-25
- 1.2.0 — 2020-04-25
- 1.0.1 — 2019-10-22
- 1.1.0 — 2019-10-01

## README

Postal Data Library
===================

Postal PIN Code API allows developers to get details of Post Office by searching Postal PIN Code 

## Features of this library
- Postal PIN Code API returns the response in JSON format.
- "Status" field in response is set to SUCCESS or ERROR, "Message" field will return message against the request 
- "PostOffice" field will return data.

## How to use
Let's see about js code:
```js
let { postalData } = require('indian-post')

postalData.getPostData(400017).then(function (res) {
  console.log('Post office data', res)
})
```
## Response For Valid PIN Codes:
```
{
  "Message": "Number of Post office(s) found: 2",
  "Status": "Success",
  "PostOffice": [
    {
      "Name": "Dharavi",
      "Description": "",
      "BranchType": "Sub Post Office",
      "DeliveryStatus": "Delivery",
      "Taluk": "Mumbai",
      "Circle": "Mumbai",
      "District": "Mumbai",
      "Division": "Mumbai  West",
      "Region": "Mumbai",
      "State": "Maharashtra",
      "Country": "India"
    }
  ]
}
```

## Response For Invalid PIN Codes or Error messages:
```
{
   "Message":"No records found",
   "Status":"Error",
   "PostOffice":null
}
```

---
_Source: https://npm.io/package/indian-post · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._