Skip to content
Documentation

Isochrone

Last updated

Compute the area reachable within given time or distance limits from a location, as GeoJSON. Contours come back as linestrings by default, or polygons when polygons is true.

GETPOSThttps://transit.land/api/v2/routing/valhalla/isochrone

Calculate areas reachable within given time or distance limits from a location, as GeoJSON linestrings or polygons.

Request

The request object, url-encoded. Identical to the POST body. Encode spaces as %20, or send the JSON without spaces. The API does not decode + as a space and rejects the request as unparseable.

contoursarray of objectsrequired

At least one of time or distance must be specified. You can only specify one metric per contour, i.e. time or distance.

contours.coloroptional string
Hex color without '#' (e.g. "ff0000").
contours.distanceoptional number
Contour limit in kilometers.
contours.timeoptional number
Contour limit in minutes.
denoiseoptional number
Factor to remove smaller contours, e.g. a value of 0.5 drops any contours that are less than half the area of the largest contour.

Default:1

generalizeoptional number
Douglas-Peucker polyline generalization tolerance in meters.
locationsarray of objectsrequired
locations.date_timeoptional string
Per-location ISO 8601 datetime override, in the format YYYY-MM-DDTHH:MM, e.g. 2016-07-03T08:06.
locations.display_latoptional number
Latitude of the map location in degrees. If provided the lat and lon parameters will be treated as the routing location and the display_lat and display_lon will be used to determine the side of street. Both display_lat and display_lon must be provided and valid to achieve the desired effect.
locations.display_lonoptional number
Latitude of the map location in degrees. If provided the lat and lon parameters will be treated as the routing location and the display_lat and display_lon will be used to determine the side of street. Both display_lat and display_lon must be provided and valid to achieve the desired effect.
locations.headingoptional integer
Preferred approach heading in degrees.
locations.heading_toleranceoptional integer
How close in degrees a given street's angle must be in order for it to be considered as in the same direction of the heading parameter. The default value is service configuration dependent (60 by default).
locations.latnumberrequired
locations.lonnumberrequired
locations.minimum_reachabilityoptional integer
Minimum number of reachable edges for a snap candidate. The default and max values are service configuration dependent (50 and 100 by default, respectively).

Default:50

locations.nameoptional string
Label echoed in the response.
locations.node_snap_toleranceoptional number
Snap-to-node distance tolerance in meters. The default value is service dependent (5 by default).
locations.preferred_layeroptional integer
If set, edges whose layer does not match this value are discarded from candidate search. Note that this is a "soft" filter, meaning if no other candidates are found, Valhalla will fall back to including edges that did not match this filter.
locations.preferred_sideoptional string
Preferred side of road to snap to.

Default:eitherAllowed:same, opposite, eitherExample:opposite

locations.radiusoptional integer
Candidate search radius in meters: all viable edge candidates within the radius are correlated. If none are found, the best one outside the radius is correlated. The default is service dependent, and defaults to 0 (only the closest edge is considered as candidate). The max value is service configuration dependent (200 by default).
locations.rank_candidatesoptional boolean
Rank snap candidates by distance to input.

Default:true

locations.search_cutoffoptional integer
Hard cutoff for candidate search in meters. Default is service configuration dependent (35000 by default).
locations.search_filteroptional object
Optional filters to exclude candidate edges based on their attribution.
locations.streetoptional string
Street address hint for snapping.
locations.street_side_cutoffoptional string

Allowed:motorway, trunk, primary, secondary, tertiary, unclassified, residential, service_otherExample:primary

locations.street_side_max_distanceoptional integer
The max distance in meters that the input coordinates or display ll can be from the edge centerline for them to be used for determining the side of street. Beyond this distance the side of street is set to none. The default value is service configuration dependent (1000 by default).
locations.street_side_toleranceoptional integer
If your input coordinate is less than this tolerance away from the edge centerline then we set your side of street to none otherwise your side of street will be left or right depending on direction of travel. The default value is service configuration dependent (5 by default).
locations.typeoptional string
First and last location are always forced to break.

Default:breakExample:break

Values
breakStop here; starts or ends a route leg. Allows U-turns.
throughPass through without stopping. No U-turn; keeps direction of travel.
viaWaypoint with a maneuver instruction but no leg-break. Allows U-turns.
break_throughLike `break` but does not allow U-turns at the location.
locations.waitingoptional number
Waiting time in seconds at this stop (break/break_through only, not origin/destination).
polygonsoptional boolean
Return polygons instead of linestrings.

Default:false

reverseoptional boolean
Compute inbound (reverse) isochrone.

Default:false

show_locationsoptional boolean
A boolean indicating whether the input locations should be returned as MultiPoint features: one feature for the exact input coordinates and one feature for the coordinates of the network node it snapped to.

Default:false

costingstringrequired
multimodal is not available. The street graph has no transit; use transit routing at /otp/plan.

Allowed:auto, bicycle, pedestrian, truck, bus, taxi, motor_scooter, motorcycle, bikeshare, auto_pedestrianExample:auto

costing_optionsoptional object
Costing options keyed by costing model name.
costing_options.autooptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.bicycleoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.bikeshareoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.busoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.motor_scooteroptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.motorcycleoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.pedestrianoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.taxioptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
costing_options.truckoptional object
Options shared by all costing models. Parsed in src/sif/dynamiccost.cc.
date_timeoptional object
date_time.typeoptional integer
0=current, 1=depart_at, 2=arrive_by, 3=invariant

Allowed:0, 1, 2, 3

date_time.valueoptional string
ISO 8601 local datetime string in the format YYYY-MM-DDTHH:MM, e.g. 2016-07-03T08:06. Required for types 1, 2, 3.
exclude_locationsoptional array of objects
A set of locations to exclude or avoid within a route.
exclude_locations.date_timeoptional string
Per-location ISO 8601 datetime override, in the format YYYY-MM-DDTHH:MM, e.g. 2016-07-03T08:06.
exclude_locations.display_latoptional number
Latitude of the map location in degrees. If provided the lat and lon parameters will be treated as the routing location and the display_lat and display_lon will be used to determine the side of street. Both display_lat and display_lon must be provided and valid to achieve the desired effect.
exclude_locations.display_lonoptional number
Latitude of the map location in degrees. If provided the lat and lon parameters will be treated as the routing location and the display_lat and display_lon will be used to determine the side of street. Both display_lat and display_lon must be provided and valid to achieve the desired effect.
exclude_locations.headingoptional integer
Preferred approach heading in degrees.
exclude_locations.heading_toleranceoptional integer
How close in degrees a given street's angle must be in order for it to be considered as in the same direction of the heading parameter. The default value is service configuration dependent (60 by default).
exclude_locations.latnumberrequired
exclude_locations.lonnumberrequired
exclude_locations.minimum_reachabilityoptional integer
Minimum number of reachable edges for a snap candidate. The default and max values are service configuration dependent (50 and 100 by default, respectively).

Default:50

exclude_locations.nameoptional string
Label echoed in the response.
exclude_locations.node_snap_toleranceoptional number
Snap-to-node distance tolerance in meters. The default value is service dependent (5 by default).
exclude_locations.preferred_layeroptional integer
If set, edges whose layer does not match this value are discarded from candidate search. Note that this is a "soft" filter, meaning if no other candidates are found, Valhalla will fall back to including edges that did not match this filter.
exclude_locations.preferred_sideoptional string
Preferred side of road to snap to.

Default:eitherAllowed:same, opposite, eitherExample:opposite

exclude_locations.radiusoptional integer
Candidate search radius in meters: all viable edge candidates within the radius are correlated. If none are found, the best one outside the radius is correlated. The default is service dependent, and defaults to 0 (only the closest edge is considered as candidate). The max value is service configuration dependent (200 by default).
exclude_locations.rank_candidatesoptional boolean
Rank snap candidates by distance to input.

Default:true

exclude_locations.search_cutoffoptional integer
Hard cutoff for candidate search in meters. Default is service configuration dependent (35000 by default).
exclude_locations.search_filteroptional object
Optional filters to exclude candidate edges based on their attribution.
exclude_locations.streetoptional string
Street address hint for snapping.
exclude_locations.street_side_cutoffoptional string

Allowed:motorway, trunk, primary, secondary, tertiary, unclassified, residential, service_otherExample:primary

exclude_locations.street_side_max_distanceoptional integer
The max distance in meters that the input coordinates or display ll can be from the edge centerline for them to be used for determining the side of street. Beyond this distance the side of street is set to none. The default value is service configuration dependent (1000 by default).
exclude_locations.street_side_toleranceoptional integer
If your input coordinate is less than this tolerance away from the edge centerline then we set your side of street to none otherwise your side of street will be left or right depending on direction of travel. The default value is service configuration dependent (5 by default).
exclude_locations.typeoptional string
First and last location are always forced to break.

Default:breakExample:break

Values
breakStop here; starts or ends a route leg. Allows U-turns.
throughPass through without stopping. No U-turn; keeps direction of travel.
viaWaypoint with a maneuver instruction but no leg-break. Allows U-turns.
break_throughLike `break` but does not allow U-turns at the location.
exclude_locations.waitingoptional number
Waiting time in seconds at this stop (break/break_through only, not origin/destination).
exclude_polygonsoptional array or object
Array of coordinate rings [[lon,lat],…] or a GeoJSON FeatureCollection. Roads intersecting these rings will be avoided during path finding. Takes one of the 2 forms listed below.
array of arraysarray of arrays
Array of closed coordinate rings. All edges intersecting any ring are excluded.
objectobject
GeoJSON FeatureCollection. Each Feature may carry a properties.levels array to restrict exclusion to specific building/indoor levels in pedestrian routing.
formatoptional string
Not all formats are supported by all endpoints, e.g. geotiff is isochrone-only.

Default:jsonAllowed:json, gpx, osrm, pbf, geotiff, mvtExample:json

idoptional string
Arbitrary request identifier echoed in the response.
languageoptional string
BCP47 locale for narrative output. See locales/ for supported values.

Default:en-US

linear_cost_factorsoptional array of objects
Customized cost factors that influence path finding, specified as an array of JSON objects. Objects can be either a GeoJSON linestring feature and a "factor" property or a plain object with a "shape" key, whose value needs to be an encoded polyline (with 6 digit precision), and a "factor" key whose value needs to be float. Valhalla will perform an edge walk (see the map matching documentation for more info) to match the geometry onto edges and use those factors in costing. Edges with factors larger than 1 will be increasingly avoided, while edges with factors smaller than 1 increasingly favored.
object with shape, factorobject
object with type, geometry, propertiesobject
unitsoptional string

Default:kmAllowed:km, miles, mi

Response

featuresarray of objects
One feature per contour, plus located points when show_locations is set.
features.geometryobject
A GeoJSON geometry, per RFC 7946.
features.propertiesobject
Contour metadata, and styling keys that render directly in most GeoJSON viewers.
features.typestring
GeoJSON feature type.

Allowed:Feature

typestring
GeoJSON collection type.

Allowed:FeatureCollection

See the Routing Platform overview for API access, travel modes, and the machine-readable schema.

Reference: Valhalla isochrone API reference