Overview
Developer Tools
Migration Guides
Travel Time Matrix API
Isochrone API
H3 API
Geohash API
Distance Map API
Routes API
Geocoding API
Additional API Reference
Error Handling
ArcGIS plugin
Alteryx plugin
/v4/h3

H3
Copy link

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
Copy link

H3 resolution of results to be returned, values can be in range [6, 12]. Limitations can be found here.

array[string]

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

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

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

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

Show child attributes
date in extended ISO-8601 format

Leave departure location at no earlier than given time. In ISO 8601 format. For example:
2026-03-16T11:00:00Z (representing UTC)
2026-03-16T11:00:00-05:00 (representing New York on Standard Time: UTC-05:00)

Maximum journey time (in seconds).

Maximum value depends on resolution parameter.

Limitations can be found here.

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
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
  • true (default) - returned cells will not cover large nearby water bodies
  • false - returned cells may cover nearby water bodies like large lakes, wide rivers and seas
object | optional

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

Show child attributes
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
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
string

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

array[string]

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

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

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

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

Limits of resolution and traveltime
Copy link

ResolutionTravel time
636000 (10 hr)
736000 (10 hr)
828800 (8 hr)
914400 (4 hr)
105400 (90 min)
112700 (45 min)
121800 (30 min)

Response Body
Copy link

array[object]
Hide child attributes
array[object]
Show child attributes

Examples
Copy link

Request
Copy link

Loading

Response Body
Copy link

Loading

Request With Unions and Intersections
Copy link

Loading

Response Body
Copy link

Loading
Hide code example

Request

Loading

Response

Loading