# PropertyPro Nigeria Autocomplete API Documentation

<p><strong>PropertyPro Nigeria Autocomplete API</strong> turns a place name into the <code>location</code> 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 <code>location</code> and the level (<code>state</code>, <code>area</code> or <code>sub_area</code>).</p><p>Pass <code>location</code> unchanged to search. An address can hold no listings today; search then returns an empty list.</p><p>A response takes about 10 to 20 seconds. Place lists are cached.</p>

- **Documentation:** [https://scrappa.co/docs/propertypro-ng-api/propertypro_ng_autocomplete](https://scrappa.co/docs/propertypro-ng-api/propertypro_ng_autocomplete)
- **API group:** PropertyPro Nigeria API
- **Endpoint:** `GET https://scrappa.co/api/propertypro-ng/autocomplete`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | string | Yes | Place name, 2 to 100 characters. Example: lekki. |
| `limit` | integer | No | Number of results, 1 to 25, default 10. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A parameter is missing or outside its allowed values. This response is not billable. |
| 503 | 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
