/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

departure_searches.id

string

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

departure_searches.coords

object

Coordinates of the departure location.

Show child attributes

departure_searches.coords.lat

float

Latitude.

departure_searches.coords.long

float

Longitude.

departure_searches.departure_time

date in extended ISO-8601 format

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

departure_searches.travel_distance

integer

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.

departure_searches.transportation

object

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

departure_searches.transportation.type

string

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

departure_searches.transportation.boarding_time

integer | optional

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.

departure_searches.transportation.disable_border_crossing

boolean | optional

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

departure_searches.level_of_detail

object | optional

Specifies level of detail of returned shape.

Show child attributes

departure_searches.level_of_detail.scale_type

string

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.

departure_searches.level_of_detail.level

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.

departure_searches.level_of_detail.square_size

integer | optional

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.

departure_searches.polygons_filter

object | optional

Specifies polygon filter of a single shape.

Show child attributes

departure_searches.polygons_filter.limit

integer

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

departure_searches.no_holes

boolean | optional

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

departure_searches.snap_penalty

string | optional

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)

arrival_searches

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

arrival_searches.id

string

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

arrival_searches.coords

object

Coordinates of the arrival location.

Show child attributes

arrival_searches.coords.lat

float

Latitude.

arrival_searches.coords.long

float

Longitude.

arrival_searches.arrival_time

date in extended ISO-8601 format

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

arrival_searches.travel_distance

integer

arrival_searches.transportation

object

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

arrival_searches.transportation.type

string

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

arrival_searches.transportation.boarding_time

integer | optional

arrival_searches.transportation.disable_border_crossing

boolean | optional

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

arrival_searches.level_of_detail

object | optional

Specifies level of detail of returned shape.

Show child attributes

arrival_searches.level_of_detail.scale_type

string

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.

arrival_searches.level_of_detail.level

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.

arrival_searches.level_of_detail.square_size

integer | optional

arrival_searches.polygons_filter

object | optional

Specifies polygon filter of a single shape.

Show child attributes

arrival_searches.polygons_filter.limit

integer

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

arrival_searches.no_holes

boolean | optional

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

arrival_searches.snap_penalty

string | optional

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)

unions

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

unions.id

string

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

unions.search_ids

array[string]

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

intersections

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

intersections.id

string

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

intersections.search_ids

array[string]

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`

results

array[object]

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

Hide child attributes

results.search_id

string

results.shapes

array[object]

Show child attributes

results.shapes.shell

array[object]

Show child attributes

results.shapes.shell.lat

float

Latitude.

results.shapes.shell.long

float

Longitude.

results.shapes.holes

array[array[object]]

Show child attributes

results.shapes.holes.lat

float

Latitude.

results.shapes.holes.long

float

Longitude.

results.properties

object

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

When `output_format` is `application/geo+json`

type

FeatureCollection

features

array[Feature]

Contains collection of features.

Hide child attributes

features.type

Feature

features.geometry

object

Contains MultiPolygon.

Show child attributes

features.geometry.type

MultiPolygon

features.geometry.coordinates

array[object]

Coordinates of polygons.

features.properties

object

Feature properties.

Show child attributes

features.properties.search_id

string

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

kml

array[object]

The kml array containing objects of xml namespace and placemark.

Hide child attributes

kml.Placemark

object

Contains name and MultiGeometry.

Show child attributes

kml.Placemark.name

FeatureCollection

kml.Placemark.MultiGeometry

FeatureCollection

Contains multiple polygons.

Show child attributes

kml.Placemark.MultiGeometry.Polygon

object

Contains response coordinates.

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

results

array[object]

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

Hide child attributes

results.search_id

string

results.shape

string

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

results.properties

object

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

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

results

array[object]

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

Hide child attributes

results.search_id

string

results.bounding_boxes

array[object]

Show child attributes

results.bounding_boxes.envelope

object

Show child attributes

results.bounding_boxes.envelope.min_lat

float

Latitude of lower left point of the box.

results.bounding_boxes.envelope.max_lat

float

Latitude of upper right point of the box.

results.bounding_boxes.envelope.min_lng

float

Longitude of lower left point of the box.

results.bounding_boxes.envelope.max_lng

float

Longitude of upper right point of the box.

results.bounding_boxes.boxes

array[object]

Show child attributes

results.bounding_boxes.boxes.min_lat

float

Latitude of lower left point of the box.

results.bounding_boxes.boxes.max_lat

float

Latitude of upper right point of the box.

results.bounding_boxes.boxes.min_lng

float

Longitude of lower left point of the box.

results.bounding_boxes.boxes.max_lng

float

Longitude of upper right point of the box.

results.properties

object

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

Distance Map

Request Body

Response Body

When output_format is application/json

When output_format is application/geo+json

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

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

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

Examples

Request

Response Body

Request With Unions and Intersections

Response Body

When `output_format` is `application/json`

When `output_format` is `application/geo+json`

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

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

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