PropertyPro Nigeria Autocomplete API turns a place name into the location address that the search endpoint needs. It matches Nigerian states, areas and sub-areas by name. Names that start with your text come first. Each result has the label, the name, the state, the location and the level (state, area or sub_area).
Pass location unchanged to search. An address can hold no listings today; search then returns an empty list.
A response takes about 10 to 20 seconds. Place lists are cached.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
1 optional filter available.
string
Required
Place name, 2 to 100 characters. Example: lekki.
coffee shops
integer
Optional
Number of results, 1 to 25, default 10.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"query": "ikate",
"results": [
{
"name": "Ikate",
"label": "Ikate, Lekki, Lagos",
"level": "sub_area",
"state": "Lagos",
"location": "lagos/lekki/ikate"
}
]
},
"meta": {
"billable": true,
"endpoint_family": "autocomplete"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or outside its allowed values. This response is not billable.
{
"errors": {
"query": [
"The query field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
PropertyPro could not be reached, or the page could not be confirmed as the requested one. Retry shortly. This response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "autocomplete"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "PropertyPro could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.