usps-webtools

USPS Web Tools API wrapper

Showing:

Popularity

Downloads/wk

1.9K

GitHub Stars

35

Maintenance

Last Commit

1mo ago

Contributors

11

Package

Dependencies

3

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Installation:

npm install usps-webtools

Usage:

Initializing the usps model with usps server url address, and user id.

Example:

const USPS = require('usps-webtools');

const usps = new USPS({
  server: 'http://production.shippingapis.com/ShippingAPI.dll',
  userId: 'USPS User id',
  ttl: 10000 //TTL in milliseconds for request
});

verify(object, callback)

Verify takes two parameters: object and callback.

object: street1, street2, city, state, zip

callback: err, address

Example

usps.verify({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA',
  zip: '94103'
}, function(err, address) {
  console.log(address);
});

zipCodeLookup(object, callback)

zipCodeLookup takes two parameters: object and callback.

object: street1, street2, city, state

callback: err, address

Example

usps.zipCodeLookup({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA'
}, function(err, address) {
  console.log(address);
});

cityStateLookup(object, callback)

cityStateLookup takes two parameters: zipcode and callback.

zipcode: 5 digit zipcode

callback: err, address

Example

usps.cityStateLookup('94107', function(err, result) {
  // result == { city: , state: , zip: }
});

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial