HexNeighborsResponse
data object
neighbors object[]
The full hex code
AF-GH-7-0GXTQD5RFZZZZThe same code without the trailing filler Zs. Every endpoint accepts either form.
AF-GH-7-0GXTQD5RFRaw H3 cell index (hex)
877576970ffffffH3 resolution level
7GhanaGHcenter object
5.6041-0.1953boundary object[]
Polygon vertices of the hex cell
5.6041-0.1953Cell area in km²
3.86Linked GhanaPostGPS code (if known)
6meta object
Unique request identifier
c86825f0-d8ca-4ae1-8226-514cc48e05c0Whether the response was served from cache
falseServer-side processing time
1.802457582sReverse-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.
1.42Reverse-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.
false{
"success": true,
"data": {
"origin": "string",
"neighbors": [
{
"code": "AF-GH-7-0GXTQD5RFZZZZ",
"short_code": "AF-GH-7-0GXTQD5RF",
"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"
}
],
"count": 6
},
"meta": {
"request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
"cached": false,
"latency": "1.802457582s",
"boundary_distance_m": 1.42,
"near_grid_boundary": false
}
}