Skip to main content
GraphHopper logo
  • Category: places & weather
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: GRAPHHOPPER
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: GRAPHHOPPER_CLUSTER_POSTSolve capacity-constrained clustering problems by assigning customers to clusters while minimizing total travel distance. Useful for delivery zone planning, sales territory optimization, and workload balancing. Supports car, bike, and foot routing profiles. Note: Free tier limited to 5 customers per request.Instant: Supported on the latest version.Instant pricing: $0.004 per 10 API credits. Credit usage varies by request.

Input Parameters

array
Optional pre-defined cluster centers. If omitted, cluster centers are computed automatically. Length must equal num_clusters if provided.
array
required
List of customers to assign to clusters. Free tier limited to 5 customers.
object
required
Routing profile and clustering constraints configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_GEOCODE_GETTool to perform forward or reverse geocoding. Use when converting between textual addresses and latitude/longitude coordinates.Instant: Supported on the latest version.Instant pricing: $0.004 per 10 API credits. Credit usage varies by request.

Input Parameters

string
Text to geocode (forward geocoding). Required when reverse=false; must be omitted if reverse=true.
string
Your GraphHopper API key. If not provided, it will be automatically injected from the connection.
string
Bounding box ‘minLon,minLat,maxLon,maxLat’. Requires reverse=false. Only provider=default.
number
Map-like zoom level controlling focus radius. Only provider=default.
boolean
Pretty-print the output. Default false.
integer
Maximum number of results. Default 5.
string
Coordinate ‘lat,lon’. Required when reverse=true; for forward geocoding, acts as location bias.
string
Bounds ‘minLon,minLat,maxLon,maxLat’. For nominatim or opencagedata.
string ("en" | "de" | "fr")
Locale of results. Default ‘en’.
number
Search radius. Default: km for provider=default when reverse=true; meters for provider=gisgraphy.
array
OSM tags to filter/include or exclude, e.g., ‘tourism:museum’ or ‘!tourism:museum’. Only provider=default.
boolean
Set to true for reverse geocoding. Default false.
string ("default" | "nominatim" | "gisgraphy" | "opencagedata")
Alternative geocoding provider.
string
ISO 3166-1 alpha-2 country filter. For nominatim, gisgraphy, or opencagedata.
boolean
Enable autocomplete (only for provider=gisgraphy and reverse=false).
number
Location bias scale between 0.0 and 1.0. Only provider=default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_GET_CLUSTER_SOLUTIONRetrieve the solution of an asynchronous clustering job by job ID. Requires your own GraphHopper API key.

Input Parameters

string
required
Job ID returned from the cluster calculation endpoint. Use this to retrieve the clustering solution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_GET_MATRIXTool to compute a distance and/or time matrix using GET request with query parameters. Use for simpler matrix requests with query parameters instead of POST body.Instant: Supported on the latest version.Instant pricing: $0.004 per 10 API credits. Credit usage varies by request.

Input Parameters

array
Specify multiple points in ‘latitude,longitude’ format for which the matrix should be calculated. The starts are identical to the destinations. If there are N points, then NxN entries will be calculated. Specify at least three points. Cannot be used together with from_point or to_point.
string
The routing profile. It determines the network, speed and other physical attributes used when computing the route. Valid values include ‘car’, ‘bike’, ‘foot’, ‘hike’, ‘mtb’, ‘racingbike’, ‘scooter’, ‘truck’, and ‘small_truck’.
array
Optional parameter. Specifies on which side a point should be relative to the driver when she leaves/arrives at a start/target/via point. Must be ‘any’, ‘left’, or ‘right’. Specify for either none or all points.
array
The destination points for the routes in ‘latitude,longitude’ format. Use together with from_point for asymmetric matrices.
boolean
Specifies whether or not the matrix calculation should return with an error as soon as possible in case some points cannot be found or some points are not connected. If set to false, the matrix will be calculated for all valid points and contain null values for entries that could not be calculated.
array
Specifies which arrays should be included in the response. Specify one or more of ‘weights’, ‘times’, ‘distances’. The units of distances are meters, times are seconds, and weights are arbitrary.
array
The origin points for the routes in ‘latitude,longitude’ format. Use together with to_point for asymmetric matrices.
array
Optional parameter. Specifies a hint for each point parameter to prefer a certain street for the closest location lookup.
array
Curbside setting for the to_point parameter. Must be ‘any’, ‘left’, or ‘right’.
array
Curbside setting for the from_point parameter. Must be ‘any’, ‘left’, or ‘right’.
array
For the to_point parameter. Specifies a hint to prefer a certain street for the closest location lookup.
array
For the from_point parameter. Specifies a hint to prefer a certain street for the closest location lookup.
array
Optional parameter to prevent snapping to specific types of roads. Supported values: ‘motorway’, ‘trunk’, ‘ferry’, ‘tunnel’, ‘bridge’, ‘ford’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_GET_MATRIX_SOLUTIONRetrieve the status and result of an asynchronous matrix computation job by job ID. Requires your own GraphHopper API key.

Input Parameters

string
required
The job ID returned when you submitted the matrix calculation job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_GET_ROUTETool to calculate the best path connecting two or more points using simple GET request. Use when you need basic routing with query parameters.Instant: Supported on the latest version.Instant pricing: From $0.004 per 10 routes; varies with route options

Input Parameters

boolean
Enable formatted output for debugging.
array
required
Route waypoints as ‘latitude,longitude’ strings. Specify at least origin and destination. Via points are possible. Example: [‘51.131,12.414’, ‘48.224,3.867’]
string
Locale for turn instructions. Examples: ‘en’, ‘de’, ‘fr’, ‘pt_PT’
array
Path detail types to include. Available: ‘street_name’, ‘street_ref’, ‘street_destination’, ‘leg_time’, ‘leg_distance’, ‘roundabout’, ‘country’, ‘time’, ‘distance’, ‘max_speed’, ‘max_weight’, ‘max_width’, ‘toll’, ‘road_class’, ‘road_class_link’, ‘road_access’, ‘road_environment’, ‘hazmat’, ‘hazmat_tunnel’, ‘hazmat_water’, ‘lanes’, ‘surface’, ‘smoothness’, ‘hike_rating’, ‘mtb_rating’, ‘foot_network’, ‘bike_network’
array
Preferred heading direction for each point in degrees (0-360, north-based clockwise). Specify one for start or one per point. Requires ch.disable=true.
string
The routing profile determining network, speed, and physical attributes. Common values: ‘car’, ‘bike’, ‘foot’, ‘motorcycle’, ‘mtb’, ‘racingbike’, ‘hike’. Default: ‘car’
array
Side of the road for leaving/arriving at each point. Specify for all points or none. Only for motor vehicles.
string
If ‘true’, reorders points to minimize total travel time. Applies route optimization limits and increases the price.
string ("round_trip" | "alternative_route")
Special routing algorithm. ‘round_trip’: returns to start with randomness. ‘alternative_route’: provides multiple route options.
boolean
Include altitude as third coordinate in response. Changes format of points and snapped_waypoints fields.
boolean
Enable flexible mode to use custom_model or advanced options below. Set to true for heading, algorithm, etc.
array
Optional road name hints for snapping each point. Specify none or the same number as points.
boolean
Whether to calculate route geometry points.
boolean
Whether to calculate and return turn-by-turn instructions.
boolean
Avoid u-turns at via-points with regard to heading_penalty. Requires ch.disable=true.
boolean
Use polyline encoding for geometry (true) or simple coordinate pairs (false).
integer
Time penalty in seconds for not obeying specified heading. Requires ch.disable=true.
integer
Random seed for deterministic round trip results. Requires algorithm=‘round_trip’.
array
Prevent snapping to specific road types. Values: ‘motorway’, ‘trunk’, ‘ferry’, ‘tunnel’, ‘bridge’, ‘ford’
integer
Approximate round trip length in meters. Requires algorithm=‘round_trip’.
integer
Maximum number of alternative paths. Requires algorithm=‘alternative_route’.
number
Maximum similarity factor between alternative and optimal route. Requires algorithm=‘alternative_route’.
number
Maximum factor by which alternatives can be longer than optimal route. Requires algorithm=‘alternative_route’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_ISOCHRONE_GETTool to compute isochrone polygons for a given point. Use when you need to determine areas reachable within time or distance constraints.Instant: Supported on the latest version.Instant pricing: $0.004 per 10 API credits. Credit usage varies by request.

Input Parameters

string
required
Start location as ‘latitude,longitude’, e.g., ‘52.529407,13.397634’. Must be a valid coordinate string.
integer
Number of isochrone rings/buckets to return. Divides time_limit/distance_limit into intervals to create nested isochrones. Default is 1.
string
required
Routing profile supported by the target Directions API, for example ‘car’, ‘bike’, or ‘foot’. Public transit requires separate GTFS/departure-time inputs that this action does not expose. Required.
integer
Maximum travel time in seconds from the start point. Either time_limit or distance_limit must be provided. Default is 600 seconds if neither is specified by the API.
boolean
Direction of reachability calculation. False (default): areas reachable FROM the point. True: areas FROM which the point can be reached.
integer
Maximum travel distance in meters from the start point. Either time_limit or distance_limit must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_MATRIX_POSTTool to calculate distance, time, or weight matrices via POST. Use when you have multiple origins/destinations or a symmetric point set and need a single batch request.Instant: Supported on the latest version.Instant pricing: $0.004 per 10 API credits. Credit usage varies by request.

Input Parameters

array
Coordinates for symmetric matrix as [longitude, latitude].
string
required
Routing profile ID (e.g. ‘car’, ‘bike’, ‘foot’).
array
Curbside per point (‘any’,‘left’,‘right’) for symmetrical.
boolean
If false, return null for unreachable entries and include hints.
array
Destination coordinates as [longitude, latitude]. Provide with from_points.
array
required
Which matrices to include.
array
Origin coordinates as [longitude, latitude]. Provide with to_points.
array
Hint per point for snapping preference (symmetrical).
array
Curbside per destination (‘any’,‘left’,‘right’).
array
Curbside per origin (‘any’,‘left’,‘right’).
array
Hint per destination for snapping preference.
array
Hint per origin for snapping preference.
array
Feature types to avoid for snapping (e.g. ‘toll’, ‘ferry’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_PROFILES_GETList custom routing profiles for your GraphHopper account using your own API key. These profiles customize routing behavior and can be used with GraphHopper routing services. The result can be empty if no profiles are returned or the feature is not activated for the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_ROUTE_POSTTool to calculate complex routes via POST /route. Use when you need advanced route planning with custom parameters.Instant: Supported on the latest version.Instant pricing: From $0.004 per 10 routes; varies with route options

Input Parameters

boolean
Enable formatted debug output
string
Locale for turn instructions
array
required
Ordered list of [lon, lat] pairs for route waypoints; at least two points required
array
List of path detail keys (e.g., ‘street_name’,‘surface’,‘max_speed’)
string
required
Vehicle profile (e.g., ‘car’, ‘bike’, ‘foot’)
array
Preferred headings in degrees; requires ch.disable=true
boolean
Reorder points to minimize travel time
string ("round_trip" | "alternative_route")
Special routing mode; requires ch.disable=true
array
Curbside to approach/leave each point
boolean
Include altitude in geometry
boolean
Enable flexible mode for custom_model and advanced options
object
Parameters for round trip; requires algorithm=‘round_trip’
boolean
Include full route geometry
array
Optional street hints; one per point
object
Custom routing rules; requires ch.disable=true
boolean
Include turn-by-turn instructions
boolean
Avoid u-turns at via points; requires ch.disable=true
boolean
Use polyline encoding for geometry
integer
Penalty (s) for deviating from heading; requires ch.disable=true
array
Road types to avoid during snapping
object
Parameters for alternative routes; requires algorithm=‘alternative_route’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_SUBMIT_MATRIX_JOBSubmit a matrix computation job for asynchronous processing and receive a job ID to retrieve results later. Requires your own GraphHopper API key.

Input Parameters

array
Coordinates for symmetric matrix as [longitude, latitude].
string
required
Routing profile ID (e.g. ‘car’, ‘bike’, ‘foot’).
array
Curbside per point (‘any’,‘left’,‘right’) for symmetrical.
boolean
If false, return null for unreachable entries and include hints.
array
Destination coordinates as [longitude, latitude]. Provide with from_points.
array
required
Which matrices to include in the result.
array
Origin coordinates as [longitude, latitude]. Provide with to_points.
array
Hint per point for snapping preference (symmetrical).
array
Curbside per destination (‘any’,‘left’,‘right’).
array
Curbside per origin (‘any’,‘left’,‘right’).
array
Hint per destination for snapping preference.
array
Hint per origin for snapping preference.
array
Feature types to avoid for snapping (e.g. ‘toll’, ‘ferry’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_UPLOAD_GPX_FILEMap-match GPX track points to the road network using your own GraphHopper API key. Results can include matched geometry, distances, travel times, road details and navigation instructions.

Input Parameters

string
Locale for turn instructions. Examples: ‘en’ (English), ‘de’ (German), ‘pt_PT’ (Portuguese), ‘fr’ (French).
string
Routing profile for map matching. Determines which road network and speed attributes are used. Common values: ‘car’ (default), ‘foot’, ‘bike’, ‘motorcycle’.
boolean
If true, include altitude (elevation) as a third coordinate in the response geometry.
string
required
GPX XML content containing GPS track points. Must be valid GPX format with at least one track segment (<trkseg>) containing track points (<trkpt> with lat/lon attributes).
boolean
If true (default), coordinates are encoded using Google’s polyline algorithm. Set to false for plain GeoJSON-style coordinates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAPHHOPPER_VRP_POSTSubmit a vehicle routing optimization request and return its job status and any available solution. Requires your own GraphHopper API key.

Input Parameters

array
One-location service orders (pickup/delivery stops)
array
required
List of at least one vehicle definition
object
Deprecated – use objectives instead (legacy algorithms)
array
Custom relationships (e.g., same-route grouping)
array
Two-location shipments with pickup and delivery
array
Objective functions to minimize
object
Routing and optimization configuration
array
Custom time/distance matrices
array
Definitions of vehicle types assignable via type_id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not