Computes all reachable locations from a given stop within a set duration. Each result entry will contain the fastest travel duration and the number of connections used.
Query parameters
`latitude,longitude[,level]` tuple with
- latitude and longitude in degrees
- (optional) level: the OSM level (default: 0)
OR
stop id
Optional. Defaults to the current time.
Departure time ($arriveBy=false) / arrival date ($arriveBy=true),
The maximum travel time in minutes. Defaults to 90. The limit may be increased by the server administrator using onetoall_max_travel_minutes option in config.yml. See documentation for details.
true = all to one, false = one to all
The maximum number of allowed transfers (i.e. interchanges between transit legs, pre- and postTransit do not count as transfers). maxTransfers=0 searches for direct transit connections without any transfers. If you want to search only for non-transit connections (FOOT, CAR, etc.), send an empty transitModes parameter instead.
If not provided, the routing uses the server-side default value which is hardcoded and very high to cover all use cases.
Warning: Use with care. Setting this too low can lead to optimal (e.g. the fastest) journeys not being found. If this value is too low to reach the destination at all, it can lead to slow routing performance.
In plan endpoints before v3, the behavior is off by one, i.e. maxTransfers=0 only returns non-transit connections.
Optional. Default is 0 minutes.
Minimum transfer time for each transfer in minutes.
Optional. Default is 0 minutes.
Additional transfer time reserved for each transfer in minutes.
Optional. Default is 1.0
Factor to multiply minimum required transfer times with. Values smaller than 1.0 are not supported.
Optional. Default is 250 meters.
Maximum matching distance in meters to match geo coordinates to the street network.
Is limited by server config variable max_max_matching_distance, larger values are capped to this limit.
Optional. Default is false.
Whether to use transfers routed on OpenStreetMap data.
Different accessibility profiles for pedestrians.
Optional. Default is FOOT.
Accessibility profile to use for pedestrian routing in transfers between transit connections and the first and last mile respectively.
Average speed for pedestrian routing in meters per second
Optional
Average speed for pedestrian routing.
Average speed for bike routing in meters per second
Optional
Average speed for bike routing.
Vehicle height for HGV routing in meters
Vehicle width for HGV routing in meters
Vehicle length for HGV routing in meters
Vehicle gross weight for HGV routing in tons
Whether the vehicle carries hazardous materials for HGV routing
Whether the vehicle carries hazardous materials dangerous to water for HGV routing
Axle count for HGV routing
Maximum axle load for HGV routing in tons
Whether the vehicle has a trailer for HGV routing
Vehicle top speed for HGV routing in km/h
Whether the vehicle is allowed to use low-emission zones for HGV routing
Different elevation cost profiles for street routing. Using a elevation cost profile will prefer routes with a smaller incline and smaller difference in elevation, even if the routed way is longer.
- NONE: Ignore elevation data for routing. This is the default behavior
- LOW: Add a low penalty for inclines. This will favor longer paths, if the elevation increase and incline are smaller.
- HIGH: Add a high penalty for inclines. This will favor even longer paths, if the elevation increase and incline are smaller.
Optional. Default is NONE.
Set an elevation cost profile, to penalize routes with incline.
- NONE: No additional costs for elevations. This is the default behavior
- LOW: Add a low cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if small detours are required.
- HIGH: Add a high cost for increase in elevation and incline along the way. This will prefer routes with less ascent, if larger detours are required.
As using an elevation costs profile will increase the travel duration, routing through steep terrain may exceed the maximal allowed duration, causing a location to appear unreachable. Increasing the maximum travel time for these segments may resolve this issue.
The profile is used for routing on both the first and last mile.
Elevation cost profiles are currently used by following street modes:
- BIKE
Optional. Default is TRANSIT which allows all transit modes (no restriction). Allowed modes for the transit part. If empty, no transit connections will be computed. For example, this can be used to allow only SUBURBAN,SUBWAY,TRAM.
Optional. Default is WALK. The behavior depends on whether arriveBy is set:
- arriveBy=true: Currently not used
- arriveBy=false: Only applies if the one place is a coordinate (not a transit stop).
A list of modes that are allowed to be used from the last transit stop to the to coordinate. Example: WALK,BIKE_SHARING.
Optional. Default is WALK. The behavior depends on whether arriveBy is set:
- arriveBy=true: Only applies if the one place is a coordinate (not a transit stop).
- arriveBy=false: Currently not used
A list of modes that are allowed to be used from the last transit stop to the to coordinate. Example: WALK,BIKE_SHARING.
Optional. Default is false.
If set to true, all used transit trips are required to allow bike carriage.
Optional. Default is false.
If set to true, all used transit trips are required to allow car carriage.
Optional. Default is false.
If set to true, all used transit trips are required to be usable without compulsory reservation.
Optional. Default is 15min which is 900.
- arriveBy=true: Currently not used
- arriveBy=false: Maximum time in seconds for the street leg at one location. Is limited by server config variable street_routing_max_prepost_transit_seconds.
Optional. Default is 15min which is 900.
- arriveBy=true: Maximum time in seconds for the street leg at one location.
- arriveBy=false: Currently not used Is limited by server config variable street_routing_max_prepost_transit_seconds.
Response
The starting position and a list of all reachable stops If no paths are found, the reachable list is empty.
Changes
Changed in 7 of the 52 revisions of this API.2418
- ○
added the new optional
queryrequest parameternoCompulsoryReservationnew-optional-request-parameter
- ○
- ●
added the new
HGVenum value to the////response property for the response statusresponse-property-enum-value-added
- ●
added the new
HGVenum value to the//response property for the response statusresponse-property-enum-value-added
- ○
added the new optional
queryrequest parametervehicleAxleCountnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleAxleLoadnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleHazmatnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleHazmatWaternew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleHeightnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleLengthnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleLezAccessnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleTopSpeednew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleTrailernew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleWeightnew-optional-request-parameter
- ○
added the new optional
queryrequest parametervehicleWidthnew-optional-request-parameter
- ○
added the enum value
HGVto the propertyitems/of thequeryrequest parameterpostTransitModesrequest-parameter-property-enum-value-added
- ○
added the enum value
HGVto the propertyitems/of thequeryrequest parameterpreTransitModesrequest-parameter-property-enum-value-added
- ○
added the enum value
HGVto the propertyitems/of thequeryrequest parametertransitModesrequest-parameter-property-enum-value-added
- ●
- ▲
for the
queryrequest parametermaxMatchingDistance, default value was changed from25to250request-parameter-default-value-changed
- ▲
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
- ●
added the new
SPECIAL_EVENTenum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
added the new
SPECIAL_EVENTenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
- ○
endpoint added
endpoint-added
- ○
- ▲
api path removed without deprecation
api-path-removed-without-deprecation
This revision also has 30 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲