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/time-filter/postcode-sectors

Travel Time Matrix (Postcode Sectors)

Find sectors that have a certain coverage from origin (or to destination) and get statistics about postcodes within such sectors. Currently only supports United Kingdom.

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

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.

The coordinates of the locations.

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-09-26T14:00:00Z (representing UTC)
2024-09-26T14:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

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

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

Show child attributes

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

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.

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.

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

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

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

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

Time in seconds required to board a ferry.
Default value is 0.
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.

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

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

Enable transit leg change limit?

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

A number between 0.0 and 1.0. For example, if 0.5 is used, only sectors that have at least 50% postcodes that can be reached within the given travel_time will be included in the response. 0 will return sectors that have at least a single reachable postcode

Properties returned about the sectors.

  • travel_time_reachable - travel time statistics calculated from reachable postcodes in the sector
  • travel_time_all - travel time statistics calculated from all postcodes in the sector
  • coverage - percentage of reachable postcodes in the sector

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

Enable range search?

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

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.

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

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.

The coordinates of the locations.

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-09-26T14:00:00Z (representing UTC)
2024-09-26T14:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

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

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

Show child attributes

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

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.

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.

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

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

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

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

Time in seconds required to board a ferry.
Default value is 0.
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.

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

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

Enable transit leg change limit?

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

A number between 0.0 and 1.0. For example, if 0.5 is used, only sectors that have at least 50% postcodes that can be reached within the given travel_time will be included in the response. 0 will return sectors that have at least a single reachable postcode

Properties returned about the sectors.

  • travel_time_reachable - travel time statistics calculated from reachable postcodes in the sector
  • travel_time_all - travel time statistics calculated from all postcodes in the sector
  • coverage - percentage of reachable postcodes in the sector

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

Enable range search?

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

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.

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

Response Body

array[object]

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

Hide child attributes

array[object]

Show child attributes

Only the properties included in the request are returned.

Show child attributes

Travel time statistics calculated from all postcodes in the sector.

Percentage of reachable postcodes in the sector. Value is from 0.0 to 100.0

Examples

Request

Loading

Response Body

Loading

Example Request

Loading

Response Body

Loading