HexBridgeResponse

successboolean

data object

gps_codestring

Example: GA-142-7281

hex_codestring

Example: AF-GH-7-0GXTQD5RFZZZZ

coordinates object

latnumber<double>

Example: 5.6041

lngnumber<double>

Example: -0.1953

regionstring

Example: Greater Accra

districtstring

Example: Accra Metropolitan

quality_scorenumber<double>

Example: 0.92

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

HexBridgeResponse

{
  "success": true,
  "data": {
    "gps_code": "GA-142-7281",
    "hex_code": "AF-GH-7-0GXTQD5RFZZZZ",
    "coordinates": {
      "lat": 5.6041,
      "lng": -0.1953
    },
    "region": "Greater Accra",
    "district": "Accra Metropolitan",
    "quality_score": 0.92
  },
  "meta": {
    "request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
    "cached": false,
    "latency": "1.802457582s",
    "boundary_distance_m": 1.42,
    "near_grid_boundary": false
  }
}