Address Validation API: Node.js Client

release levelnpm version

client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Address Validation API API.
  4. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @googlemaps/addressvalidation

Using the client library

/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** *  Required. The address being validated. Unformatted addresses should be *  submitted via `address_lines` google.type.PostalAddress.address_lines. *  The total length of the fields in this input must not exceed 300 *  characters. *  Supported regions can be found in the *  FAQ (https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported). *  The language_code google.type.PostalAddress.language_code  value in the *  input address is reserved for future uses and is ignored today. The *  validated address result will be populated based on the preferred language *  for the given address, as identified by the system. *  The Address Validation API ignores the values in *  recipients google.type.PostalAddress.recipients  and *  organization google.type.PostalAddress.organization. Any values in those *  fields will be discarded and not returned. Please do not set them. */// const address = {}/** *  This field must be empty for the first address validation request. If *  more requests are necessary to fully validate a single address (for *  example if the changes the user makes after the initial validation need to *  be re-validated), then each followup request must populate this field with *  the *  response_id google.maps.addressvalidation.v1.ValidateAddressResponse.response_id *  from the very first response in the validation sequence. */// const previousResponseId = 'abc123'/** *  Enables USPS CASS compatible mode. This affects _only_ the *  google.maps.addressvalidation.v1.ValidationResult.usps_data  field of *  google.maps.addressvalidation.v1.ValidationResult. Note: for USPS CASS *  enabled requests for addresses in Puerto Rico, a *  google.type.PostalAddress.region_code  of the `address` must be provided *  as "PR", or an google.type.PostalAddress.administrative_area  of the *  `address` must be provided as "Puerto Rico" (case-insensitive) or "PR". *  It's recommended to use a componentized `address`, or alternatively specify *  at least two google.type.PostalAddress.address_lines  where the first line *  contains the street number and name and the second line contains the city, *  state, and zip code. */// const enableUspsCass = true// Imports the Addressvalidation libraryconst {AddressValidationClient} = require('@googlemaps/addressvalidation').v1;// Instantiates a clientconst addressvalidationClient = newAddressValidationClient();async function callValidateAddress() {  // Construct request  const request = {    address: {      regionCode: 'US',      addressLines: ['1600 Amphitheatre Pkwy', 'Mountain View CA 94040'],    },  };  // Run request  const response = await addressvalidationClient.validateAddress(request);  console.log(response);}callValidateAddress();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Address_validation.provide_validation_feedbacksource codeOpen in Cloud Shell
Address_validation.validate_addresssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheAddress Validation API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @googlemaps/addressvalidation@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inbeta. This means it is expected to bemostly stable while we work toward a general availability release; however,complete stability is not guaranteed. We will address issues and requestsagainst beta libraries with a high priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.