IsochroneRequest

location objectrequired

Centre point for the isochrone (hex code or lat/lng).

hexstring

AfriHex code at resolution 7

Example: AF-GH-7-0GXTJJB0ZZZZZ

point object

Raw coordinate

lngnumber<double>

Example: -0.1867

latnumber<double>

Example: 5.604

headinginteger

Device 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

Example: 270

modestring

Travel mode used for reachability calculation.

Possible values: [driving, foot, bicycle, motor_scooter]

Default value: driving

Example: driving

contours object[]required

One or more time thresholds. Contours are returned in the same order.

Possible values: >= 1, <= 6

Array [

time_minutesnumber<double>required

Travel-time threshold in minutes.

Possible values: >= 1 and <= 120

Example: 15

]

polygonsboolean

When true (default), each contour is a filled GeoJSON Polygon. When false, contours are returned as LineString polylines.

Default value: true

Example: true

generalizenumber<double>

Douglas-Peucker simplification tolerance in metres. Higher values produce smaller payloads with less detail. 0 = no simplification.

Example: 50

hex_codesboolean

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

Default value: false

Example: true

IsochroneRequest

{
  "location": {
    "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
}