With the GraphHopper Directions API for Business you get a reliable and fast routing service with world wide coverage. We offer A-to-B routing via the Routing API optionally with turn instructions and elevation data as well as route optimization with various constraints like time window and capacity restrictions. Also it is possible to get all distances between all locations with our fast Matrix API.
- To use the Directions API you need an API key. Get it for free here.
- Read the documentation for the Routing API, the Route Optimization API, the Matrix API and the Geocoding API below or try the examples in our dashboard.
- To increase your query limits for production you pay online within a few minutes via credit card or debit advice.
You can see the Routing and Geocoding API in action at GraphHopper Maps.
If you have problems or questions please see the FAQ.md or contact us.
- JavaScript - try the live examples
- Java
Do not hesitate to share your client code with us!
The Routing API is documented here.
The endpoint is https://graphhopper.com/api/[version]/route
You get an example response via:
curl "https://graphhopper.com/api/1/route?point=51.131108%2C12.414551&point=48.224673%2C3.867187&vehicle=car&locale=de&debug=true&points_encoded=false&key=[YOUR_KEY]"
Where you need to replace the key with your own
The Route Optimization API is documented here. Please note the alpha status
The endpoint is https://graphhopper.com/api/[version]/vrp
The Route Optimization API works in two steps
- Publish your problem json:
curl -X POST -H "Content-Type: application/json" "https://graphhopper.com/api/1/vrp/optimize?key=[YOUR_KEY]" --data @your-vrp-problem.json - Poll every 500ms until a solution is available:
curl -X GET "https://graphhopper.com/api/1/vrp/solution/[RETURNED_JOB_ID]?key=[YOUR_KEY]"
For more details also about the format of the your-vrp-problem.json file you can use one of the examples.
The Matrix API is documented here
The endpoint is https://graphhopper.com/api/[version]/matrix
You get an example response for a 3x3 matrix looks via:
curl "https://graphhopper.com/api/1/matrix?point=49.932707%2C11.588051&point=50.241935%2C10.747375&point=50.118817%2C11.983337&type=json&vehicle=car&debug=true&out_array=weights&out_array=times&out_array=distances&key=[YOUR_KEY]"
The Geocoding API is not yet production grade. Please help us improve it and give us feedback! See the documentation here.
The endpoint is https://graphhopper.com/api/[version]/geocode
You get an example response via:
curl "https://graphhopper.com/api/1/geocode?q=berlin&locale=de&debug=true&key=[YOUR_KEY]"
Append &debug=true for a formatted output.
Use this API to calculate reachability polygons for specific points. Please contact us for further details.
Use this API to match recorded GPS tracks with roads and associate useful information like turn instructions or speed limit, i.e. it provides a 'snap to road' functionality. Please contact us for further details.
If you have problems please report them here.
Read the terms of services carefully and make sure your user are agreeing to be bound by GraphHopper's Terms of Use too.
All packages require a prominent attribution of GraphHopper. This means you include a link to graphhopper.com in a place where you utilize the GraphHopper Directions API. It is important to note that the user has to see this only one time e.g. once per application start or at the first website access. The user must have the possibility and enough time to read and click on the link (at least 4 seconds). I.e. a short living splash screen isn't what we want, instead we ask you to place it e.g. below a search input. As a simple example have a look at GraphHopper Maps
An HTML snippet for this is:
Powered by <a href="https://graphhopper.com/#directions-api">GraphHopper API</a>If you use the on-premises option please use the following snippet:
Uses <a href="https://graphhopper.com/">GraphHopper</a>For small screens (less than 190mm diagonal) it can be only the link without 'powered by' or 'uses'. If you need a custom or white-label solution please contact us.
Additionally to our attribution you need to include attribution to OpenStreetMap.
| HTTP error code | Reason |
|---|---|
| 400 | Something was wrong in your request. Too few or too many points. .. |
| 401 | Authentication necessary |
| 413 | Too many parameters in the URL, you'll have to use the JSON format and POST requests |
| 429 | API limit reached, you'll also get an email about this, and the header properties will give you more information: X-RateLimit-Limit (your current daily limit), X-RateLimit-Remaining (your remaining credits) and X-RateLimit-Reset (the number of seconds that you have to wait). |
| 500 | Internal server error. We get automatically a notification and will try to fix this fast. |
| 501 | Only a special list of vehicles is supported |
{
"message": "Cannot find point 2: 2248.224673, 3.867187",
"hints": [{"message": "something", ...}]
}Sometimes a point can be "off the road" and you'll get 'cannot find point', this normally does not indicate a bug in the routing engine and is expected to a certain degree if too far away.
| JSON path/attribute | Description |
|---|---|
| message | Not intended to be displayed to the user as it is currently not translated |
| hints | An optional list of details regarding the error message e.g. [{"message": "first error message in hints"}] |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent