search icon
Overview
Developer Tools
Travel Time Matrix API
Isochrone API
Distance Map API
Routes API
Geocoding API
Additional API Reference
Error Handling
ArcGIS plugin
QGIS plugin
Alteryx plugin
TravelTime.comchevronDocs
/v4/distance-map

Distance Map

Visualise where's reachable within a travel distance catchment area.

Access URL: https://api.traveltimeapp.com/v4/distance-map

Request Body

array[object]

Searches based on departure time. Leave departure location at no earlier than given time. You can define a maximum of 10 searches.

Hide child attributes

Used to identify each search in the results array. Must be unique among all searches.

Coordinates of the departure location.

Show child attributes

date in extended ISO-8601 format

Leave departure location at no earlier than given time. In ISO 8601 format. For example:
2024-11-08T13:00:00Z (representing UTC)
2024-11-08T13:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

Maximum journey distance (in meters).
Maximum value is 800000 (800km) as standard. Minimum value is 75 meters. Although travel distance is limited, computations are still performed by considering fastest journeys (minimizing travel time). To discuss increasing this, please contact sales@traveltime.com.

Transportation mode and related parameters. type is a mandatory field, but all other fields are optional and default values are used if not specified.

Show child attributes

driving, walking, cycling, driving+ferry,, cycling+ferry, ferry.

Additional road types to included when executing search. Only affects driving and driving+ferry transportation modes. Possible values:

  • track - unpaved roads that only allow very slow driving speed or even require an off-road capable vehicle.
  • restricted - roads that are not publicly accessible and may require a special permit. By default all of these roads are excluded from the search.

Time in seconds required to board a ferry.
Default value is 0.
Cannot be higher than 1h.
Used in driving, walking, cycling, driving+ferry, cycling+ferry and ferry transportation modes.

If set to true, the crossing of country borders is disabled. Only available with the driving transportation mode, and is enabled by default (false).

Specifies level of detail of returned shape.

Show child attributes
  • simple - level of detail is specified using a simple enumeration.
  • simple_numeric - level of detail is specified using integer numbers. This scale is an extension of simple scale.
  • coarse_grid - level of detail is specified as a number, used to simplify the generated shape to a set grid density.

Exact availability depends on the licence plan.

string | integer | optional

Can either be a string or an integer depending on scale_type used.

  • Available options when using string: lowest, low, medium, high, highest. Used with simple scale type. Returned shape will be the least detailed with the lowest setting, and the most detailed with the highest setting.

  • Available options when using integer are between -20 and 2. Used with simple_numeric scale type. The lower the number, the less detailed the returned shape will be. Values from -2 to 2 are equivalent to the lowest to highest values of the simple scale type.

Used with the coarse_grid scale type.
Specifies the side length (in metres) of the squares used to construct the shape. The larger the value, the less detailed the returned shape will be.
Minimum value is 600.

Specifies polygon filter of a single shape.

Show child attributes

At most this amount of largest polygons will be returned in a single shape. Must be greater than 0.

boolean | optional

Enable to remove holes from returned polygons.
Note that this will likely result in loss in accuracy.

object | optional

Adjusts the process of looking up the nearest roads from the departure / arrival points.

Show child attributes
  • enabled (default) - walking time and distance from the departure location to the nearest road and from the nearest road to the arrival location are added to the total travel time and distance of a journey.
  • disabled - these walking times and distances are not added to the total reported values (i.e the journey effectively starts and ends at the nearest points on the road network).
  • both_drivable_and_walkable (default) - journey can only start or end on roads that are accessible by both: cars and pedestrians. This effectively means journeys can not start / end on motorways.
  • any_drivable - journey can start or end on any road accessible by a car (including motorways).

array[object]

Searches based on arrival time. Arrive at destination location at no later than given time. You can define a maximum of 10 searches.

Show child attributes

Used to identify each search in the results array. Must be unique among all searches.

Coordinates of the arrival location.

Show child attributes

Latitude.

Longitude.

date in extended ISO-8601 format

Be at arrival location at no later than given time. In ISO 8601 format. For example:
2024-11-08T13:00:00Z (representing UTC)
2024-11-08T13:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

Maximum journey distance (in meters).
Maximum value is 800000 (800km) as standard. Minimum value is 75 meters. Although travel distance is limited, computations are still performed by considering fastest journeys (minimizing travel time). To discuss increasing this, please contact sales@traveltime.com.

Transportation mode and related parameters. type is a mandatory field, but all other fields are optional and default values are used if not specified.

Show child attributes

driving, walking, cycling, driving+ferry,, cycling+ferry, ferry.

Additional road types to included when executing search. Only affects driving and driving+ferry transportation modes. Possible values:

  • track - unpaved roads that only allow very slow driving speed or even require an off-road capable vehicle.
  • restricted - roads that are not publicly accessible and may require a special permit. By default all of these roads are excluded from the search.

Time in seconds required to board a ferry.
Default value is 0.
Cannot be higher than 1h.
Used in driving, walking, cycling, driving+ferry, cycling+ferry and ferry transportation modes.

If set to true, the crossing of country borders is disabled. Only available with the driving transportation mode, and is enabled by default (false).

Specifies level of detail of returned shape.

Show child attributes
  • simple - level of detail is specified using a simple enumeration.
  • simple_numeric - level of detail is specified using integer numbers. This scale is an extension of simple scale.
  • coarse_grid - level of detail is specified as a number, used to simplify the generated shape to a set grid density.

Exact availability depends on the licence plan.

string | integer | optional

Can either be a string or an integer depending on scale_type used.

  • Available options when using string: lowest, low, medium, high, highest. Used with simple scale type. Returned shape will be the least detailed with the lowest setting, and the most detailed with the highest setting.

  • Available options when using integer are between -20 and 2. Used with simple_numeric scale type. The lower the number, the less detailed the returned shape will be. Values from -2 to 2 are equivalent to the lowest to highest values of the simple scale type.

Used with the coarse_grid scale type.
Specifies the side length (in metres) of the squares used to construct the shape. The larger the value, the less detailed the returned shape will be.
Minimum value is 600.

Specifies polygon filter of a single shape.

Show child attributes

At most this amount of largest polygons will be returned in a single shape. Must be greater than 0.

boolean | optional

Enable to remove holes from returned polygons.
Note that this will likely result in loss in accuracy.

object | optional

Adjusts the process of looking up the nearest roads from the departure / arrival points.

Show child attributes
  • enabled (default) - walking time and distance from the departure location to the nearest road and from the nearest road to the arrival location are added to the total travel time and distance of a journey.
  • disabled - these walking times and distances are not added to the total reported values (i.e the journey effectively starts and ends at the nearest points on the road network).
  • both_drivable_and_walkable (default) - journey can only start or end on roads that are accessible by both: cars and pedestrians. This effectively means journeys can not start / end on motorways.
  • any_drivable - journey can start or end on any road accessible by a car (including motorways).

array[object]

Define the unions of shapes that are the results of previously defined departure or arrival searches. You can define a maximum of 10 unions per request.

Hide child attributes

string

Used to identify each search in the results array. Must be unique among all searches.

array[string]

A list of the search ids referring to the shapes to be used for calculating the union.

array[object]

Define the intersections of shapes that are the results of previously defined departure or arrival searches. You can define a maximum of 10 intersections per request.

Hide child attributes

Used to identify each search in the results array. Must be unique among all searches.

A list of the search ids referring to the shapes to be used for calculating the intersection.

Response Body

We support multiple response formats, the format can be set using the Accept header. Supported formats:

  • application/json - This is the default if no format was specified.
  • application/vnd.wkt+json
  • application/vnd.wkt-no-holes+json
  • application/geo+json
  • application/vnd.google-earth.kml+xml
  • application/vnd.bounding-boxes+json - This format does not include holes

When output_format is application/json

array[object]

The results array which is sorted lexicographically by the id attribute.

Hide child attributes

array[object]

Show child attributes

array[object]

Show child attributes

Latitude.

Longitude.

array[array[object]]

Show child attributes

Latitude.

Longitude.

Properties array. Only the properties included in the request are returned.

When output_format is application/geo+json

FeatureCollection

array[Feature]

Contains collection of features.

Hide child attributes

Feature

Contains MultiPolygon.

Show child attributes

MultiPolygon

Coordinates of polygons.

Feature properties.

Show child attributes

When output_format is application/vnd.google-earth.kml+xml

array[object]

The kml array containing objects of xml namespace and placemark.

Hide child attributes

Contains name and MultiGeometry.

Show child attributes

FeatureCollection

FeatureCollection

Contains multiple polygons.

Show child attributes

Contains response coordinates.

When output_format is application/vnd.wkt+json or application/vnd.wkt-no-holes+json

array[object]

The results array which is sorted lexicographically by the id attribute.

Hide child attributes

A string containing the shape in Well-known text (WKT)

Properties array. Only the properties included in the request are returned.

When output_format is application/vnd.bounding-boxes+json

array[object]

The results array which is sorted lexicographically by the id attribute.

Hide child attributes

array[object]

Show child attributes
Show child attributes

Latitude of lower left point of the box.

Latitude of upper right point of the box.

Longitude of lower left point of the box.

Longitude of upper right point of the box.

Show child attributes

Latitude of lower left point of the box.

Latitude of upper right point of the box.

Longitude of lower left point of the box.

Longitude of upper right point of the box.

Properties array. Only the properties included in the request are returned.

Examples

Request

Loading

Response Body

Loading

Request With Unions and Intersections

Loading

Response Body

Loading

Example Request

Loading

Response body

Loading