Skip to main content

PlusCodeResponse

successboolean
Example: true
data object
plus_codestring
Example: 6CQXJR37+F6
latnumber<double>

Cell centre

lngnumber<double>

Cell centre

code_lengthinteger
Example: 10
bounds object
northnumber<double>
southnumber<double>
eastnumber<double>
westnumber<double>
hexstring

AfriHex resolution-7 code for the centre, when inside a supported country.

Example: AF-GH-7-0GXTQD5RFZZZZ
recovered_from_shortboolean

True when a short code was expanded using ref

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
PlusCodeResponse
{
"success": true,
"data": {
"plus_code": "6CQXJR37+F6",
"lat": 0,
"lng": 0,
"code_length": 10,
"bounds": {
"north": 0,
"south": 0,
"east": 0,
"west": 0
},
"hex": "AF-GH-7-0GXTQD5RFZZZZ",
"recovered_from_short": true
},
"meta": {
"request_id": "c86825f0-d8ca-4ae1-8226-514cc48e05c0",
"cached": false,
"latency": "1.802457582s",
"boundary_distance_m": 1.42,
"near_grid_boundary": false
}
}