Repository files navigation

This project offers JavaScript clients for theGraphHopper Directions API.

Install the lib with npm:

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

Note the different package name in 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/directions-api-js-client');window.onload=function(){letdefaultKey="[Sign-up for free and get your own key: https://www.graphhopper.com/products/]";letghRouting=newGraphHopper.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 hereconsole.log(json);}).catch(err=>{console.error(err.message);});};

In order to run the tests, you have to register for a key onGraphHopper.Either set your key as environment variable usingexport GHKEY=YOUR_KEY or set your key inspec/helpers/config.js.You can run all tests vianpm 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.

You can either use ourbundled version, including all APIs or you can use only thepieces you need.

You needthe routing client.

There is also a different client developed from the communityhere.

You needthe optimization client.

You needthe isochrone client

You needthe matrix client.

You needthe geocoding client.

You needthe map matching client and thetogeojson.js

Set the version you like to publish in thepackage.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 taggit tag <tag> <commit-hash>git push origin --tag <tag>

GitHub will then build and publish the commit to NPM.

Code stands under Apache License 2.0