JSON API /v4/time-filter/fast

Travel Time Matrix (Fast)

A very fast version of Time Filter. However, the request parameters are much more limited. Currently only supports UK and Ireland.

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

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

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 sales@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, fares

arrival_searches.many_to_one.transportation

object

Show child attributes

arrival_searches.many_to_one.transportation.type

string

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

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

array[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

string

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

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 sales@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, fares

arrival_searches.one_to_many.transportation

object

Show child attributes

arrival_searches.one_to_many.transportation.type

string

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

Response Body

results

array[object]

The results array which is sorted lexicographically by the id attribute

Hide child attributes

results.search_id

string

results.locations

array[object]

Show child attributes

results.locations.id

string

results.locations.properties

object

Only the properties included in the request are returned here.

Show child attributes

results.locations.properties.travel_time

integer | optional

Travel time in seconds.

results.locations.properties.fares

object | optional

Show child attributes

results.locations.properties.fares.tickets_total

array[object]

Show child attributes

results.locations.properties.fares.tickets_total.type

string

month or year

results.locations.properties.fares.tickets_total.price

float

results.locations.properties.fares.tickets_total.currency

string

ISO 4217 currency code

results.unreachable

array[string]

Ids of locations that cannot be reached within the specified travel_time.

Examples

Request

Loading

Response Body

Loading

Example Request

Loading

Response Body

Loading