Skip to main content

IsochroneRequest

location objectrequired

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

gps_codestring

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.

Example: GA-183-8164
plus_codestring

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

Example: 6CQXJR37+F6
location_idstring

Physical location selector, mutually exclusive with hex/point/profile_slug. Private locations require a profile grant.

entrance_idstring

Canonical gate ID; requires profile_slug or location_id and excludes entrance_type.

entrance_revisioninteger

Reject if the approved revision changed.

Possible values: >= 1

profile_slugstring

Address-profile handle; access is checked before resolving coordinates/entrances

entrance_typestring

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]

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