/v4/time-filter/postcodes

Travel Time Matrix (Postcodes)

Find reachable postcodes from origin (or to destination) and get statistics about such postcodes. Currently only supports United Kingdom.

Request Body

departure_searches

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

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.

departure_searches.coords

object

The coordinates of the locations.

Show child attributes

departure_searches.coords.lat

float

Latitude.

departure_searches.coords.long

float

Longitude.

departure_searches.travel_time

integer

Maximum journey time (in seconds).
Maximum value is 14400 (4 hours) as standard. To discuss increasing this, please contact sales@traveltime.com.

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-10-21T11:00:00Z (representing UTC)
2024-10-21T11:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

departure_searches.transportation

object

Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type.

Show child attributes

departure_searches.transportation.type

string

cycling, driving, driving+train (only in Great Britain), public_transport, walking, coach, bus, train, ferry, driving+ferry, cycling+ferry or cycling+public_transport (only in Netherlands).

Note - a driving+train search is for driving then train (i.e driving to a station and continuing by train). The maximum drive time can be configured using the driving_time_to_station parameter

departure_searches.transportation.include_roads

array[string] | optional

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.

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.transportation.pt_change_delay

integer | optional

Time in seconds needed to board public transportation vehicle.
Default is 0.
Cannot be higher than travel_time.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

departure_searches.transportation.max_changes

object | optional

Upper limit for the number of changes between public transit legs in a journey.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the max_changes parameter is ignored.

Show child attributes

departure_searches.transportation.max_changes.enabled

boolean

Enable transit leg change limit?

departure_searches.transportation.max_changes.limit

integer

Maximum number of changes between transit legs in a journey. Must be at least 0.

departure_searches.transportation.walking_time

integer | optional

Maximum time (in seconds) allowed for walking at the start and end of a public transport journey. i.e:

the maximum walking time from the origin to the first stop/station, and
the maximum walking time from the final stop/station to the destination

These limits are independent and not cumulative. They only apply to the first and last walking legs of the journey - all walking times between public transport legs are limited to 600s (10 minutes) each.

The default value is 900.

Cannot be higher than travel_time.

Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

departure_searches.transportation.driving_time_to_station

integer | optional

Maximum time (in seconds) allowed for driving from the origin to the train station.
Default value is 1800.
Cannot be higher than travel_time.
Used only in driving+train transportation mode.

departure_searches.transportation.cycling_time_to_station

integer | optional

Maximum time (in seconds) allowed for cycling (including any ferry transfers) from from the origin to the first stop/station.
Default value is 900.
Cannot be higher than travel_time.
Used only in cycling+public_transport transportation mode.

departure_searches.transportation.parking_time

integer | optional

Time in seconds required to park a car or a bicycle.
Default value is 300.
Cannot be higher than travel_time.
Used in driving+train and cycling+public_transport transportation modes.

departure_searches.transportation.boarding_time

integer | optional

Time in seconds required to board a ferry.
Default value is 0.
Cannot be higher than travel_time.
Used in public_transport, ferry, driving+ferry, cycling+ferry and cycling+public_transport transportation modes. For public_transport mode, pt_change_delay is used instead.

departure_searches.properties

array[string]

Properties to be returned about the postcodes. Possible values: travel_time, distance

departure_searches.range

object | optional

When enabled, range adds a departure window to the departure time, and results are returned for any journeys that depart during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes range search parameters are ignored.

Show child attributes

departure_searches.range.enabled

boolean

Enable range search?

departure_searches.range.max_results

integer

Maximum number of results to return. Limited to 5 results.

departure_searches.range.width

integer

When enabled, range adds an arrival window to the arrival time, and results are returned for any journeys that arrive during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes the parameter is ignored.

departure_searches.snapping

object | optional

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

Show child attributes

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

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

array[object]

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

Show child attributes

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

arrival_searches.coords

object

The coordinates of the locations.

Show child attributes

arrival_searches.coords.lat

float

Latitude.

arrival_searches.coords.long

float

Longitude.

arrival_searches.travel_time

integer

Maximum journey time (in seconds).
Maximum value is 14400 (4 hours) as standard. To discuss increasing this, please contact sales@traveltime.com.

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-10-21T11:00:00Z (representing UTC)
2024-10-21T11:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

arrival_searches.transportation

object

Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type.

Show child attributes

arrival_searches.transportation.type

string

Note - a driving+train search is for driving then train (i.e driving to a station and continuing by train). The maximum drive time can be configured using the driving_time_to_station parameter

arrival_searches.transportation.include_roads

array[string] | optional

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.

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.transportation.pt_change_delay

integer | optional

arrival_searches.transportation.max_changes

object | optional

Show child attributes

arrival_searches.transportation.max_changes.enabled

boolean

Enable transit leg change limit?

arrival_searches.transportation.max_changes.limit

integer

Maximum number of changes between transit legs in a journey. Must be at least 0.

arrival_searches.transportation.walking_time

integer | optional

Maximum time (in seconds) allowed for walking at the start and end of a public transport journey. i.e:

the maximum walking time from the origin to the first stop/station, and
the maximum walking time from the final stop/station to the destination

The default value is 900.

Cannot be higher than travel_time.

Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes.

arrival_searches.transportation.driving_time_to_station

integer | optional

Maximum time (in seconds) allowed for driving from the origin to the train station.
Default value is 1800.
Cannot be higher than travel_time.
Used only in driving+train transportation mode.

arrival_searches.transportation.cycling_time_to_station

integer | optional

arrival_searches.transportation.parking_time

integer | optional

Time in seconds required to park a car or a bicycle.
Default value is 300.
Cannot be higher than travel_time.
Used in driving+train and cycling+public_transport transportation modes.

arrival_searches.transportation.boarding_time

integer | optional

arrival_searches.properties

array[string]

Properties to be returned about the postcodes. Possible values: travel_time, distance

arrival_searches.range

object | optional

When enabled, range adds an arrival window to the arrival time, and results are returned for any journeys that arrive during this window.
In the results array, the properties of these multiple alternative results are sorted by travel_time in ascending order.
Disabled by default.
Used in public_transport, coach, bus, train, driving+train and cycling+public_transport transportation modes. For other modes range search parameters are ignored.

Show child attributes

arrival_searches.range.enabled

boolean

Enable range search?

arrival_searches.range.max_results

integer

Maximum number of results to return. Limited to 5 results.

arrival_searches.range.width

integer

arrival_searches.snapping

object | optional

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

Show child attributes

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

Response Body

results

array[object]

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

Hide child attributes

results.search_id

string

results.postcodes

array[object]

Show child attributes

results.postcodes.code

string

results.postcodes.properties

array[object]

May contain multiple elements if range was specified, single element otherwise. Sorted by travel_time. Only the properties included in the request are returned

Show child attributes

results.postcodes.properties.travel_time

integer | optional

Travel time in seconds.

results.postcodes.properties.distance

integer | optional

Distance in meters.

Examples

Request

Loading

Response Body

Loading

Example Request

Loading

Response Body

Loading