IsochroneRequest
location objectrequired
Centre point for the isochrone (hex code or lat/lng).
A GhanaPostGPS digital address, with or without dashes. It is
looked up in the GhanaPostGPS registry and the route uses the
centre of its cell. An unknown or malformed code returns
400 VALIDATION_ERROR.
GA-183-8164A full Plus Code (Open Location Code), case-insensitive. The route
uses the centre of its cell (about 14 m across for a 10-digit
code). Short codes are rejected as ambiguous; expand them first
with GET /v2/pluscode/{code}?ref=lat,lng.
6CQXJR37+F6Physical location selector, mutually exclusive with hex/point/profile_slug. Private locations require a profile grant.
Canonical gate ID; requires profile_slug or location_id and excludes entrance_type.
Reject if the approved revision changed.
Possible values: >= 1
Address-profile handle; access is checked before resolving coordinates/entrances
Optional explicit entrance for profile_slug. Otherwise defaults to truck/main gate selection, then profile point.
Possible values: [main, truck_gate, loading_dock, visitor, staff, pedestrian, compound]
AfriHex code at resolution 7
AF-GH-7-0GXTJJB0ZZZZZpoint object
Raw coordinate
-0.18675.604Device compass bearing in degrees (0 = north). On dual-carriageway roads it disambiguates which carriageway the endpoint snaps to, so routes don't begin with a phantom U-turn. Omit when unknown.
Possible values: >= 0 and <= 359
270Travel mode used for reachability calculation.
Possible values: [driving, foot, bicycle, motor_scooter]
drivingdrivingcontours object[]required
One or more time thresholds. Contours are returned in the same order.
Possible values: >= 1, <= 6
Travel-time threshold in minutes.
Possible values: >= 1 and <= 120
15When true (default), each contour is a filled GeoJSON Polygon.
When false, contours are returned as LineString polylines.
truetrueDouglas-Peucker simplification tolerance in metres. Higher values
produce smaller payloads with less detail. 0 = no simplification.
50When true, each contour polygon is intersected with the H3 hex grid
(resolution 7) and the covered hex codes are returned in hex_codes.
Forces polygons: true. Use this to find which portfolio zones fall
within the reachable area.
falsetrue{
"location": {
"gps_code": "GA-183-8164",
"plus_code": "6CQXJR37+F6",
"location_id": "string",
"entrance_id": "string",
"entrance_revision": 0,
"profile_slug": "string",
"entrance_type": "main",
"hex": "AF-GH-7-0GXTJJB0ZZZZZ",
"point": {
"lng": -0.1867,
"lat": 5.604
},
"heading": 270
},
"mode": "driving",
"contours": [
{
"time_minutes": 15
}
],
"polygons": true,
"generalize": 50,
"hex_codes": true
}