/v4/h3/fast

H3 Fast

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 higher performance version of the /h3 endpoint, but with fewer configurable parameters and more limited 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.

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 returns the reachable area for journeys arriving at the chosen arrival location. 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.coords

object

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

Show child attributes

arrival_searches.many_to_one.coords.lat

float | optional

Latitude.

arrival_searches.many_to_one.coords.long

float | optional

Longitude.

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

object

Show child attributes

arrival_searches.many_to_one.transportation.type

string

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

Note - a driving+public_transport search is for driving then public transport (i.e driving to a stop/station and continuing by public transport). The driving leg of the journey is limited to maximum 30 minutes."

arrival_searches.many_to_one.arrival_time_period

string

Possible values: weekday_morning

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 hello@traveltime.com.

arrival_searches.many_to_one.snapping

object | optional

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

Show child attributes

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

array[object]

This returns the reachable area for journeys departing from the chosen departure location. 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.coords

object

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

Show child attributes

arrival_searches.one_to_many.coords.lat

float | optional

Latitude.

arrival_searches.one_to_many.coords.long

float | optional

Longitude.

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

arrival_searches.one_to_many.transportation

object

Show child attributes

arrival_searches.one_to_many.transportation.type

string

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

arrival_searches.one_to_many.arrival_time_period

string

Possible values: weekday_morning

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 hello@traveltime.com.

arrival_searches.one_to_many.snapping

object | optional

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

Show child attributes

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