# OpenRent Autocomplete API Documentation

<p><strong>OpenRent Autocomplete API</strong> suggests up to ten place names and postcodes for a partial query. Pass a suggestion as the <code>location</code> of the search endpoint. A valid query with no suggestions returns an empty list.</p>

- **Documentation:** [https://scrappa.co/docs/openrent-api/openrent_autocomplete](https://scrappa.co/docs/openrent-api/openrent_autocomplete)
- **API group:** OpenRent API
- **Endpoint:** `GET https://scrappa.co/api/openrent/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 | Partial place name or postcode, e.g. manch. |

## Example response

```json
{
    "data": {
        "query": "manch",
        "suggestions": [
            {
                "slug": "manchester",
                "term": "Manchester",
                "label": "Manchester"
            },
            {
                "slug": "bolton-greater-manchester",
                "term": "Bolton, Greater Manchester",
                "label": "Bolton, Greater Manchester"
            },
            {
                "slug": "stockport-greater-manchester",
                "term": "Stockport, Greater Manchester",
                "label": "Stockport, Greater Manchester"
            }
        ]
    },
    "meta": {
        "billable": true,
        "duration_ms": 640,
        "endpoint_family": "autocomplete"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A public parameter is missing or invalid. This response is not billable. |
| 503 | Service Unavailable | OpenRent is temporarily unavailable. This response is not billable and can be retried. |

## 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)