JSON API /v4/time-filter/fast

Travel Time Matrix (Fast)

A high performance version of the Travel Time Matrix (Time Filter) endpoint. This endpoint offers fewer configurable parameters but can handle very large volumes of locations with extremely low response times.

Available in most of the countries currently supported by the TravelTime API - a full list can be found at the bottom of the page here.

Request Body

locations

array[object]

Define your locations to use later in arrival_searches.

Hide child attributes

locations.id

string

You will have to reference this id in your searches. It will also be used in the response body. Must be unique among all locations.

locations.coords

object

The coordinates of the locations.

Show child attributes

locations.coords.lat

float

Latitude.

locations.coords.lng

float

Longitude.

arrival_searches

object

Searches based on arrival time. Arrive at a destination or multiple destinations at no later than given time.

Hide child attributes

arrival_searches.many_to_one

array[object]

This allows you to specify a single arrival location and multiple departure locations. You can define a maximum of 10 searches.

Hide child attributes

arrival_searches.many_to_one.id

string

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

arrival_searches.many_to_one.arrival_location_id

string

The id of the location to arrive at. Must reference an id from the locations array.

arrival_searches.many_to_one.departure_location_ids

array[string]

The ids of the locations to depart from. Must reference ids from the locations array. You can define a maximum of 100,000 departure_location_ids.

arrival_searches.many_to_one.travel_time

integer

Maximum journey time (in seconds).
Maximum value is 10800 (3 hours) as standard. To discuss increasing this, please contact hello@traveltime.com.

arrival_searches.many_to_one.arrival_time_period

string

Possible values: weekday_morning

arrival_searches.many_to_one.properties

array[string]

Properties to be returned about the points. Possible values: travel_time, distance (only for driving+ferry, cycling+ferry and walking+ferry transportation types), fares (UK only).

arrival_searches.many_to_one.transportation

object

Show child attributes

arrival_searches.many_to_one.transportation.type

string

Possible values: public_transport, walking+ferry, cycling+ferry, driving+ferry, driving+public_transport.

Note - a driving+public_transport search is for driving then public transport (i.e driving to a stop/station and continuing by public transport). The driving leg of the journey is limited to maximum 30 minutes."

arrival_searches.many_to_one.transportation.traffic_model

string | optional

Determines the level of traffic used in driving journeys. Possible values:

peak (default) - represents the typical traffic conditions for a midweek morning,
off_peak - represents the typical traffic conditions at night time.

Can only be specified with driving+ferry and driving transportation types.

arrival_searches.many_to_one.snapping

object | optional

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

Show child attributes

arrival_searches.many_to_one.snapping.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.many_to_one.snapping.accept_roads

string | optional

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).

arrival_searches.many_to_one.snapping.threshold

integer | optional

Maximum distance (in meters) allowed between the departure/arrival locations and the nearest road that supports the selected travel mode. An arrival location beyond this limit will return an error. Departure locations beyond this limit will return unreachable results. Default value is 1000.

arrival_searches.one_to_many

array[object]

This allows you to specify a single departure location and multiple arrival locations. You can define a maximum of 10 searches.

Show child attributes

arrival_searches.one_to_many.id

string

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

arrival_searches.one_to_many.departure_location_id

string

The id of the location to depart from. Must reference an id from the locations array.

arrival_searches.one_to_many.arrival_location_ids

array[string]

The ids of the locations to arrive at. Must reference ids from the locations array. You can define a maximum of 100,000 arrival_location_ids.

arrival_searches.one_to_many.travel_time

integer

Maximum journey time (in seconds).
Maximum value is 10800 (3 hours) as standard. To discuss increasing this, please contact hello@traveltime.com.

arrival_searches.one_to_many.arrival_time_period

string

Possible values: weekday_morning

arrival_searches.one_to_many.properties

array[string]

Properties to be returned about the points. Possible values: travel_time, distance (only for driving+ferry, cycling+ferry and walking+ferry transportation types), fares (UK only).

arrival_searches.one_to_many.transportation

object

Show child attributes

arrival_searches.one_to_many.transportation.type

string

Possible values: public_transport, walking+ferry, cycling+ferry, driving+ferry, driving+public_transport.

arrival_searches.one_to_many.transportation.traffic_model

string | optional

Determines the level of traffic used in driving journeys. Possible values:

peak (default) - represents the typical traffic conditions for a midweek morning,
off_peak - represents the typical traffic conditions at night time.

Can only be specified with driving+ferry and driving transportation types.

arrival_searches.one_to_many.snapping

object | optional

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

Show child attributes

arrival_searches.one_to_many.snapping.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.one_to_many.snapping.accept_roads

string | optional

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).

arrival_searches.one_to_many.snapping.threshold

integer | optional

Maximum distance (in meters) allowed between the departure/arrival locations and the nearest road that supports the selected travel mode. A departure location beyond this limit will return an error. Arrival locations beyond this limit will return unreachable results. Default value is 1000.