Parse a free-text address
GET/v2/address/parse
Decomposes a free-text Ghanaian address into structured components
(road, suburb, city, unit, po_box, ...) plus relative-position
anchors — the "adjacent Goil Filling Station" / "behind Kejetia
Market" clauses that identify a landmark rather than a street. Resolve
anchor names via /v2/landmarks/geocode; use geocode_query (the
cleaned structural remainder) with /v2/search.
GhanaPost GPS / AfriHex codes short-circuit with is_code: true, the
extracted code, and no parse — even when pasted with trailing text
("GA-183-8164, Accra"). Look up code via /v2/lookup or
/v2/hexcode.
Requires the libpostal sidecar (LIBPOSTAL_URL); returns 503 when not
configured on the deployment.
Request
Responses
- 200
- 400
- 503
Parsed address components
Missing or over-long query
Address parsing not configured on this deployment