@graphhopper/graphhopper-js-api-client

JavaScript client for the Directions API

This project offers JavaScript clients for the GraphHopper Directions API.

Getting Started

NPM

Install the lib with npm:

npm install @graphhopper/graphhopper-js-api-client --save

Notice the @graphhopper organization since 15th September 2025.

You can either require the whole client enabling you to use every GraphHopper API, but you can also only require the pieces you need.

require('graphhopper-js-api-client');
 
window.onload = function() {
  let defaultKey = "[Sign-up for free and get your own key: https://www.graphhopper.com/products/]";
  let ghRouting = new GraphHopper.Routing({key: defaultKey}, {profile:"car", elevation: false});

  ghRouting.doRequest({points:[[8.534317, 47.400905], [8.538265, 47.394108]]})
    .then(json => {
       // Add your own result handling here
       console.log(json);
    })
    .catch(err => {
       console.error(err.message);
    });
};

Running Tests

In order to run the tests, you have to register for a key on GraphHopper. Either set your key as environment variable using export GHKEY=YOUR_KEY or set your key in spec/helpers/config.js. You can run all tests via npm test. If you only want to run a single spec file, you can use the --spec option, e.g., npm test --spec spec/GraphHopperRoutingSpec.js.

Integrate the APIs in your application

You can either use our bundled version, including all APIs or you can use only the pieces you need.

GraphHopper Routing API

You need the routing client.

There is also a different client developed from the community here.

GraphHopper Route Optimization API

You need the optimization client.

GraphHopper Isochrone API

You need the isochrone client

GraphHopper Matrix API

You need the matrix client.

GraphHopper Geocoding API

You need the geocoding client.

GraphHopper Map Matching API

You need the map matching client and the togeojson.js

Releasing a new Version to NPM

Set the version you like to publish in the package.json. Every version can only be published once and cannot be overwritten.

Tag the commit you like to publish for example like this:

git log # get the commit hash of the commit you want to tag
git tag <tag> <commit-hash>
git push origin --tag <tag>

GitHub will then build and publish the commit to NPM.

License

Code stands under Apache License 2.0