/v4/time-filter/postcodes
Find reachable postcodes from origin (or to destination) and get statistics about such postcodes. Currently only supports United Kingdom.
array[object]
Searches based on departure time. Leave departure location at no earlier than given time. You can define a maximum of 10
searches.
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.
object
The coordinates of the locations.
float
Latitude.
float
Longitude.
integer
Maximum journey time (in seconds). Maximum value is 14400
(4 hours) as standard. To discuss increasing this, please contact sales@traveltime.com.
date in extended ISO-8601 format
Leave departure location at no earlier than given time. In ISO 8601 format. For example:
2023-10-02T12:00:00Z
(representing UTC)
2023-10-02T12:00:00-05:00
(representing New York on Standard Time: UTC-05:00)
Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type
.
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).
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
).
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.
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.
Enable transit leg change limit?
Maximum number of changes between transit legs in a journey. Must be at least 0
.
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.
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.
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.
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.
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.
array[string]
Properties to be returned about the postcodes. Possible values: travel_time
, distance
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.
boolean
Enable range search?
integer
Maximum number of results to return. Limited to 5
results.
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.
array[object]
Searches based on departure time. Leave departure location at no earlier than given time. You can define a maximum of 10
searches.
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.
object
The coordinates of the locations.
float
Latitude.
float
Longitude.
integer
Maximum journey time (in seconds). Maximum value is 14400
(4 hours) as standard. To discuss increasing this, please contact sales@traveltime.com.
date in extended ISO-8601 format
Be at arrival location at no later than given time. In ISO 8601 format. For example:
2023-10-02T12:00:00Z
(representing UTC)
2023-10-02T12:00:00-05:00
(representing New York on Standard Time: UTC-05:00)
Transportation mode and related parameters. The default parameters are sensible and it is usually enough to only specify the type
.
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).
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
).
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.
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.
Enable transit leg change limit?
Maximum number of changes between transit legs in a journey. Must be at least 0
.
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.
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.
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.
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.
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.
array[string]
Properties to be returned about the postcodes. Possible values: travel_time
, distance
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.
boolean
Enable range search?
integer
Maximum number of results to return. Limited to 5
results.
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.
array[object]
The results array which is sorted lexicographically by the id
attribute.
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
integer | optional
Travel time in seconds.
integer | optional
Distance in meters.
Example Request
Loading
Response Body
Loading