Lookup address
GET/v2/lookup
Resolves a GhanaPostGPS digital address to geographic coordinates and location details.
Accepts both formatted (GS-0623-4895) and compact (GS06234895) address formats.
In Mijoride-first deployments, fresh local records are reused; otherwise
Mijoride is queried first, with the existing provider as fallback. Successful
refreshes merge populated address fields into the database before updating
the forward cache. The last good local record may be returned during a
provider outage, so check data.refreshed_at when freshness matters.
postcode is the postal code (for example, GS0623); postal_area is its
readable name (Nyanyano 623). community and area describe the locality
(Official Town) and are separate from the postal area. Provider and
refresh fields are optional on legacy or unenriched records.
meta.cached: true means the result came from local cache or database;
it does not mean that the record is outdated. Provider credentials and
token rotation are managed by the server; clients continue using the
same endpoint and authentication.
Request
Responses
- 200
- 400
- 404
- 429
- 502
Address resolved successfully
Invalid or missing address
Address not found
Rate limit exceeded
Response Headers
Maximum requests allowed in the window
Requests remaining in current window
Seconds until the rate limit resets
Upstream service error