/v4/h3

H3

Calculate the travel times to all H3 cells within a travel time catchment area. Return the max, min, and mean travel time for each cell.

This is a less performant version of the /h3/fast endpoint, but with more configurable parameters and greater geographic coverage.

Request Body

resolution

string

H3 resolution of results to be returned, values can be in range [1, 8].

properties

array[string]

Properties to be returned for each H3 hex. Possible values: min, max, mean.

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

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

departure_searches.coords

object

Coordinates of the departure location. Use either latitude and longitude, or the centroid of an h3 cell.

Show child attributes

departure_searches.coords.lat

float | optional

Latitude.

departure_searches.coords.long

float | optional

Longitude.

departure_searches.coords.h3_centroid

string | optional

H3 index centroid of which will be treated as the location of departure. Mutually exclusive with lat and lng parameters.

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:
2025-02-27T12:00:00Z (representing UTC)
2025-02-27T12:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

departure_searches.travel_time

integer

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

departure_searches.transportation

object

Transportation mode and related parameters. type is a mandatory field, but all other fields are optional and default values are used if not specified.

Show child attributes

departure_searches.transportation.type

string

cycling, driving, driving+train (only in Great Britain), driving+public_transport (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). Similarly, driving+public_transport search is for driving then taking any kind of public transportation.driving+public_transport is not supported on postcode endpoints. 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.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, driving+public_transport and cycling+public_transport transportation modes.

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, driving+public_transport 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 and driving+public_transport transportation mode.

departure_searches.transportation.cycling_time_to_station

integer | optional

Maximum time (in seconds) allowed for cycling (including any ferry transfers) 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, driving+public_transport 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 ferry, driving+ferry, driving+public_transport, cycling+ferry and cycling+public_transport transportation modes. For public_transport mode, pt_change_delay is used instead.

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.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, driving+public_transport and cycling+public_transport transportation modes. For other modes the max_changes parameter is ignored.

Hide 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.range

object | optional

When enabled, range adds a departure window to the departure time, and a combined shape of all possible journeys departing within the window is returned.
Disabled by default.
Used in public_transport, coach, bus, train and driving+train transportation modes. For other modes range search parameters are ignored.

Show child attributes

departure_searches.range.enabled

boolean

Enable range search?

departure_searches.range.width

integer

The width of the range window (in seconds).
The window is applied 'forwards' from the departure time. For example, with a departure_time of 9am and a range width of 1 hour, all journeys departing between 9am and 10am will be included.
Maximum value is 43200 (12 hours).

departure_searches.properties

array[string] | optional

Properties to be returned about the shapes.
Possible values: is_only_walking.
When selected, the is_only_walking parameter will return a value of True if a journey only involves walking (e.g for a public transport search in an area with no public transport available).

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 arrival time. Arrive at destination location at no later than given time. You can define a maximum of 10 searches.

Show child attributes

arrival_searches.id

string

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

arrival_searches.coords

object

Coordinates of the arrival location. Use either latitude and longitude, or the centroid of an h3 cell.

Show child attributes

arrival_searches.coords.lat

float | optional

Latitude.

arrival_searches.coords.long

float | optional

Longitude.

arrival_searches.coords.h3_centroid

string | optional

H3 index centroid of which will be treated as the location of arrival. Mutually exclusive with lat and lng parameters.

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:
2025-02-27T12:00:00Z (representing UTC)
2025-02-27T12:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

arrival_searches.travel_time

integer

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

arrival_searches.transportation

object

Transportation mode and related parameters. type is a mandatory field, but all other fields are optional and default values are used if not specified.

Show child attributes

arrival_searches.transportation.type

string

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.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, driving+public_transport and cycling+public_transport transportation modes.

arrival_searches.transportation.pt_change_delay

integer | optional

arrival_searches.transportation.driving_time_to_station

integer | optional

arrival_searches.transportation.cycling_time_to_station

integer | optional

arrival_searches.transportation.parking_time

integer | optional

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

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

object | optional

When enabled, range adds an arrival window to the arrival time, and a combined shape of all possible journeys arriving within the window is returned.
Disabled by default.
Used in public_transport, coach, bus, train and driving+train transportation modes. For other modes range search parameters are ignored.

Show child attributes

arrival_searches.range.enabled

boolean

Enable range search?

arrival_searches.range.width

integer

The width of the range window (in seconds).
The window is applied 'backwards' from the arrival time. For example, with an arrival_time of 9am and a range width of 1 hour, all journeys arriving between 8am and 9am will be included.
Maximum value is 43200 (12 hours).

arrival_searches.properties

array[string] | optional

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

unions

array[object]

Define the unions of shapes that are the results of previously defined departure or arrival searches. You can define a maximum of 10 unions per request.

Hide child attributes

unions.id

string

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

unions.search_ids

array[string]

A list of the search ids referring to the shapes to be used for calculating the union.

intersections

array[object]

Define the intersections of shapes that are the results of previously defined departure or arrival searches. You can define a maximum of 10 intersections per request.

Hide child attributes

intersections.id

string

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

intersections.search_ids

array[string]

A list of the search ids referring to the shapes to be used for calculating the intersection.