# SpareRoom Locations

Autocomplete a place text into SpareRoom places. Each match has a display name, a where value for the search endpoint, a type and the area ids. The answer holds at most 20 matches. Areas, towns and postcode districts resolve. Full postcodes do not resolve and return an empty list, which is not billed.

- **Documentation:** [https://scrappa.co/docs/spareroom-api/spareroom_locations](https://scrappa.co/docs/spareroom-api/spareroom_locations)
- **API group:** SpareRoom API
- **Endpoint:** `GET https://scrappa.co/api/spareroom/locations`

## 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 |
| --- | --- | --- | --- |
| `q` | string | Yes | Place text with at least 2 characters, for example man. |

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | A parameter is missing or invalid. This response is not billable. |  |
|  | The upstream is unavailable, refused the request or answered in an unexpected shape. 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)