Skip to main content
GET
/
v1
/
search
/
autocomplete
Segment-aware autocomplete
curl --request GET \
  --url https://api.postcode.gov.ng/v1/search/autocomplete \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "suggestions": [
      {
        "code": "<string>",
        "label": "<string>"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
q
string
required

Partial postcode, e.g. 'EK 01 A'

Response

200 - application/json

Suggestions for the active segment

​
data
object