Noteworthy Programming Masterpiece
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

cdyne-address

0.1.5 • Public • Published

cdyne-address

module that allows you to communicate with the CDYNE PAV API from node.js

See the official CDYNE PAV Specsheet for more detailed documentation.

Installation

This module is published in NPM

npm install cdyne-address --save

Usage

// Import module
var CdyneAddressAPI = require('cdyne-address');
// Create an instance with your license key
var client = new CdyneAddressAPI('license_key');

Methods

verifyAddress

verifyAddress accepts a U.S. or Canadian address as input and returns a corrected, standardized address, with geolocation, mailing industry, and census data. The service will try to match the input to USPS address data even when the provided information is misspelled or missing.

verifyAddress(primaryAddressLine, secondaryAddressLine, city, state, zip, options, callback)
client.verifyAddress('111 Grandby St', '', 'Norfolk', 'VA', '23510', {
  // options
  ReturnGeoLocation: true
}, function(error, data) {
  console.log(data);
});

Example Response (some fields omitted for brevity)

{
  CityName: 'NORFOLK',
  Country: 'USA',
  County: 'NORFOLK CITY',
  CountyNum: '710',
  FinanceNumber: '516522',
  GeoLocationInfo:
   { AreaCode: '757',
     AvgLatitude: '36.846818',
     AvgLongitude: '-76.292110',
     FromLatitude: '36.846344',
     FromLongitude: '-76.292363',
     HasDaylightSavings: true,
     TimeZone: 'EST',
     ToLatitude: '36.847292',
     ToLongitude: '-76.291857' },
  IntelligentMailBarcodeKey: '+Md+yEHLZoK1AHH/kdcL0g==',
  PrimaryDeliveryLine: '111 GRANBY ST',
  ReturnCode: 100,
  StateAbbreviation: 'VA',
  StreetName: 'GRANBY',
  Suffix: 'ST',
  ZipCode: '23510-1603'
}

options

The options parameter expects an object. Options will allow additional information about the address to be returned, if available.

// Possible options
{
  "ReturnCaseSensitive": true, // turn off default “all uppercase” return of street names.
  "ReturnCensusInfo": true,
  "ReturnCityAbbreviation": true,
  "ReturnGeoLocation": true,
  "ReturnLegislativeInfo": true,
  "ReturnMailingIndustryInfo": true,
  "ReturnResidentialIndicator": true,
  "ReturnStreetAbbreviated": true,
}

Keywords

none

install

npm i cdyne-address

Downloadsweekly downloads

17

version

0.1.5

license

none

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar