GraphHopper

Explicit cluster definitions (optional).

List of customers to assign to clusters.

Routing and clustering settings.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Text to geocode (forward geocoding). Required when reverse=false; must be omitted if reverse=true.

Your GraphHopper API key

Bounding box 'minLon,minLat,maxLon,maxLat'. Requires reverse=false. Only provider=default.

Map-like zoom level controlling focus radius. Only provider=default.

Pretty-print the output. Default false.

Maximum number of results. Default 5.

Coordinate 'lat,lon'. Required when reverse=true; for forward geocoding, acts as location bias.

Bounds 'minLon,minLat,maxLon,maxLat'. For nominatim or opencagedata.

Locale of results. Default 'en'.

Search radius. Default: km for provider=default when reverse=true; meters for provider=gisgraphy.

OSM tags to filter/include or exclude, e.g., 'tourism:museum' or '!tourism:museum'. Only provider=default.

Set to true for reverse geocoding. Default false.

Alternative geocoding provider.

ISO 3166-1 alpha-2 country filter. For nominatim, gisgraphy, or opencagedata.

Enable autocomplete (only for provider=gisgraphy and reverse=false).

Location bias scale between 0.0 and 1.0. Only provider=default.

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Start location as 'lat,lon', e.g., '52.529407,13.397634'

Number of isochrone buckets (optional)

Routing profile, e.g., 'car', 'bike', 'foot'

Travel time limit in seconds (optional)

Compute reverse flow if true

Travel distance limit in meters (optional)

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Coordinates for symmetric matrix as [longitude, latitude].

Routing profile ID (e.g. 'car', 'bike', 'foot').

Curbside per point ('any','left','right') for symmetrical.

If false, return null for unreachable entries and include hints.

Destination coordinates as [longitude, latitude]. Provide with from_points.

Which matrices to include.

Origin coordinates as [longitude, latitude]. Provide with to_points.

Hint per point for snapping preference (symmetrical).

Curbside per destination ('any','left','right').

Curbside per origin ('any','left','right').

Hint per destination for snapping preference.

Hint per origin for snapping preference.

Feature types to avoid for snapping (e.g. 'toll', 'ferry').

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

GraphHopper API key for authentication

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

Enable formatted debug output

Locale for turn instructions

Ordered list of [lon, lat] pairs for route waypoints; at least two points required

List of path detail keys (e.g., 'street_name','surface','max_speed')

Vehicle profile (e.g., 'car', 'bike', 'foot')

Preferred headings in degrees; requires ch.disable=true

Reorder points to minimize travel time

Special routing mode; requires ch.disable=true

Curbside to approach/leave each point

Include altitude in geometry

Enable flexible mode for custom_model and advanced options

Parameters for round trip; requires algorithm='round_trip'

Include full route geometry

Optional street hints; one per point

Custom routing rules; requires ch.disable=true

Include turn-by-turn instructions

Avoid u-turns at via points; requires ch.disable=true

Use polyline encoding for geometry

Penalty (s) for deviating from heading; requires ch.disable=true

Road types to avoid during snapping

Parameters for alternative routes; requires algorithm='alternative_route'

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

GPX file with name and base64-encoded content

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not

One-location service orders (pickup/delivery stops)

List of at least one vehicle definition

Deprecated – use `objectives` instead (legacy algorithms)

Custom relationships (e.g., same-route grouping)

Two-location shipments with pickup and delivery

Objective functions to minimize

Routing and optimization configuration

Custom time/distance matrices

Definitions of vehicle types assignable via type_id

Data from the action execution

Error if any occurred during the execution of the action

Whether or not the action execution was successful or not