Node.js Client for Google Maps Services

[!IMPORTANT]

Some parts of this library are only compatible with Legacy Services. Using the Legacy Services requires enabling each API on your Google Cloud project by following the direct links: Places API (Legacy), Directions API (Legacy), Distance Matrix API (Legacy).

The newer Google Maps APIs each provide their own npm-package:

• @googlemaps/places
• @googlemaps/routing
• @googlemaps/maps-platform-datasets
• @googlemaps/addressvalidation

Description

This client library brings the following [Google Maps Web Services APIs] to your server-side Node.js applications:

• Maps Static API
• Elevation API
• Geocoding API
• Roads API
• Time Zone API

As well as the following legacy APIs:

• Directions API (Legacy)
• Places API (Legacy)
• Distance Matrix API (Legacy)

Requirements

• Sign up with Google Maps Platform
• A Google Maps Platform project with the desired API(s) from the above list enabled
• An API key associated with the project above

API Key Security

This client library is designed for use in server-side applications.

In either case, it is important to add API key restrictions to improve its security. Additional security measures, such as hiding your key from version control, should also be put in place to further improve the security of your API key.

Check out the API Security Best Practices guide to learn more.

[!NOTE] This library for server-side only Attempting to use it client-side, in either the browser or any other environment like React Native, may in some cases work, but mostly will not. Please refrain from reporting issues with these environments when attempting to use them, since server-side Node.js applications is the only supported environment for this library. For other environments, try the Maps JavaScript API, which contains a comparable feature set, and is explicitly intended for use with client-side JavaScript.

Usage

npm install @googlemaps/google-maps-services-js

Below is a simple example calling the elevation method on the client class.

Import the Google Maps Client using TypeScript and ES6 module:

1import {Client} from "@googlemaps/google-maps-services-js";

Alternatively using JavaScript without ES6 module support:

1const {Client} = require("@googlemaps/google-maps-services-js");

Now instantiate the client to make a call to one of the APIs.

1const client = new Client({});
2
3client
4  .elevation({
5    params: {
6      locations: [{ lat: 45, lng: -110 }],
7      key: process.env.MAPS_API_KEY,
8    },
9    timeout: 1000, // milliseconds
10  })
11  .then((r) => {
12    console.log(r.data.results[0].elevation);
13  })
14  .catch((e) => {
15    console.log(e.response.data.error_message);
16  });

Documentation

For more information, see the reference documentation. The TypeScript types are the authoritative documentation for this library and may differ slightly from the descriptions.

Developing

In order to run the end-to-end tests, you'll need to supply your API key via an environment variable.

$ export MAPS_API_KEY=YOUR_API_KEY
$ npm test

Migration

This section discusses the migration from @google/maps to @googlemaps/google-maps-services-js and the differences between the two.

Note: The two libraries do not share any methods or interfaces.

The primary difference is @google/maps exposes a public method that takes individual parameters as arguments while @googlemaps/google-maps-services-js exposes methods that take params, headers, body, instance(see Axios). This allows direct access to the transport layer without the complexity that was inherent in the old library. Below are two examples.

Old (@google/maps)

1const googleMapsClient = require('@google/maps').createClient({
2  key: 'your API key here'
3});
4
5googleMapsClient
6  .elevation({
7    locations: {lat: 45, lng: -110}
8  })
9  .asPromise()
10  .then(function(r) {
11    console.log(r.json.results[0].elevation);
12  })
13  .catch(e => {
14  console.log(e);
15  });

New (@googlemaps/google-maps-services-js):

1const client = new Client({});
2
3client
4  .elevation({
5    params: {
6      locations: [{ lat: 45, lng: -110 }],
7      key: process.env.MAPS_API_KEY
8    },
9    timeout: 1000 // milliseconds
10  }, axiosInstance)
11  .then(r => {
12    console.log(r.data.results[0].elevation);
13  })
14  .catch(e => {
15    console.log(e);
16  });

The primary differences are in the following table.

Old	New
Can provide params	Can provide params, headers, instance, timeout (see Axios Request Config)
API key configured at Client	API key configured per method in params object
Retry is supported	Retry is configurable via axios-retry or retry-axios
Does not use promises by default	Promises are default
Typings are in @types/googlemaps	Typings are included
Does not support keep alive	Supports keep alive
Does not support interceptors	Supports interceptors
Does not support cancelalation	Supports cancellation

Premium Plan Authentication

Authentication via client ID and URL signing secret is provided to support legacy applications that use the Google Maps Platform Premium Plan. The Google Maps Platform Premium Plan is no longer available for sign up or new customers. All new applications must use API keys.

1const client = new Client({});
2
3client
4  .elevation({
5    params: {
6      locations: [{ lat: 45, lng: -110 }],
7      client_id: process.env.GOOGLE_MAPS_CLIENT_ID,
8      client_secret: process.env.GOOGLE_MAPS_CLIENT_SECRET
9    },
10    timeout: 1000 // milliseconds
11  })
12  .then(r => {
13    console.log(r.data.results[0].elevation);
14  })
15  .catch(e => {
16    console.log(e.response.data.error_message);
17  });

Contributing

Contributions are welcome and encouraged! If you'd like to contribute, send us a pull request and refer to our code of conduct and contributing guide.

Terms of Service

This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform Terms of Service.

This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.

European Economic Area (EEA) developers

If your billing address is in the European Economic Area, effective on 8 July 2025, the Google Maps Platform EEA Terms of Service will apply to your use of the Services. Functionality varies by region. Learn more.

Support

This library is offered via an open source license. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the Deprecation Policy. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.

This library adheres to semantic versioning to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.

If you find a bug, or have a feature request, please file an issue on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our developer community channels. If you'd like to contribute, please check the contributing guide.

You can also discuss this library on our Discord server.