HexLocationResponse

successboolean

Example: true

data object

codestring

Human-readable hex code

Example: AF-GH-7-0GXTQD5RFZZZZ

h3_indexstring

Raw H3 cell index (hex)

Example: 877576970ffffff

resolutioninteger

H3 resolution level

Example: 7

countrystring

Example: Ghana

country_codestring

Example: GH

center object

latnumber<double>

Example: 5.6041

lngnumber<double>

Example: -0.1953

boundary object[]

Polygon vertices of the hex cell

Array [

latnumber<double>

Example: 5.6041

lngnumber<double>

Example: -0.1953

]

area_km2number<double>

Cell area in km²

Example: 3.86

gps_codestring

Linked GhanaPostGPS code (if known)

regionstring

districtstring

meta object

request_idstring<uuid>

Unique request identifier

Example: c86825f0-d8ca-4ae1-8226-514cc48e05c0

cachedboolean

Whether the response was served from cache

Example: false

latencystring

Server-side processing time

Example: 1.802457582s

boundary_distance_mnumber<double>nullable

Reverse-geocode responses only. Distance in metres from the queried coordinate to the nearest edge of the resolved GhanaPostGPS grid cell. Omitted when the upstream response carried no cell bounds.

Example: 1.42

near_grid_boundaryboolean

Reverse-geocode responses only. True when boundary_distance_m is small enough that an ordinary GPS fix's jitter could plausibly have resolved to the neighbouring cell's code instead — the documented cause of the same property getting different GhanaPostGPS codes depending on where you stand.

Example: false

HexLocationResponse

{
  "success": true,
  "data": {
    "code": "AF-GH-7-0GXTQD5RFZZZZ",
    "h3_index": "877576970ffffff",
    "resolution": 7,
    "country": "Ghana",
    "country_code": "GH",
    "center": {
      "lat": 5.6041,
      "lng": -0.1953
    },
    "boundary": [
      {
        "lat": 5.6041,
        "lng": -0.1953
      }
    ],
    "area_km2": 3.86,
    "gps_code": "string",
    "region": "string",
    "district": "string"
  },
  "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
  }
}