# Rightmove Location Search

Resolve a UK place name into the location identifier every other Rightmove endpoint needs. Start here: it returns stable region, outcode and postcode ids alongside ephemeral street-level ones.

- **Documentation:** [https://scrappa.co/docs/rightmove-api/rightmove_typeahead](https://scrappa.co/docs/rightmove-api/rightmove_typeahead)
- **API group:** Rightmove API
- **Endpoint:** `GET https://scrappa.co/api/rightmove/locations/typeahead`

## 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 to resolve, e.g. "Clapham". |
| `limit` | integer | No | Maximum matches to return, up to 50. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/rightmove/locations/typeahead?query=Clapham"
```

## Example response

```json
{
    "data": {
        "matches": [],
        "count": 0
    }
}
```

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