# find-zipcode

> find zipcode by address using usps

Latest version **1.0.1** (published 2020-08-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install find-zipcode
pnpm add find-zipcode
yarn add find-zipcode
bun add find-zipcode
```

## 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.0.1 |
| Published | 2020-08-27 |
| First published | 2020-08-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | had5678 |
| Maintainers | had5678 |

## Links

- npm: https://www.npmjs.com/package/find-zipcode
- npm.io page: https://npm.io/package/find-zipcode

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.20.0
- [http-status-codes](https://npm.io/package/http-status-codes.md) ^2.1.2

## Recent versions

- 1.0.1 (latest) — 2020-08-27
- 1.0.0 — 2020-08-27

## README

Zip Code Find
================

Find ZipCode by address, by using [USPS](https://tools.usps.com/zip-code-lookup.htm?byaddress) service.

Usage
-----
    const zipcodes = require('find-zipcode');
    
Lookup By Address
--------------

This function gets 4 parameters:

* address1: **767 Fifth Avenue**
* address2: not mandatory
* city: **New York**
* state: **NY**


    const { getZipcodeByAddress } = require('find-zipcode');
    
    async function find() {
        return getZipcodeByAddress('767 Fifth Avenue', undefined, 'New York', 'NY');
    }
    
    find().then((result) => console.log(result)).catch((e) => console.error(e));
    
    
The result:

    { zip5: '10153', zip4: '0023' }
    
TODO
----

Add support for more find options.

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