Rightmove API endpoint
Returns Rightmove location suggestions for the required `query` (up to 200 characters). `limit` defaults to 10 and is capped at 20. Each result has an `id` such as `REGION^87490`, a `name`, a `full_name` when Rightmove gives one, and an `entity_type` such as `REGION` or `POSTCODE`. Use the `id` as `location` in Rightmove search.
/rightmove/autocomplete| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | yes | — | Location query string (maximum 200 characters) |
limit | integer | no | 10 | Maximum suggestions to return (max 20) |
| Field | Type | Description |
|---|---|---|
query | string | Echo of the input query |
results[].id | string | Rightmove location identifier |
results[].name | string | Short display name |
results[].full_name | string | Full hierarchical name when supplied by Rightmove |
results[].entity_type | string | Rightmove location type, such as REGION or POSTCODE |
400 — Invalid or missing query parameter503 — Upstream error (Rightmove unreachable or response format changed)500 — Internal server errormatches with numeric id, type, and displayName fields)| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| id | 20 | |
| name | 20 | “London” and 19 other values |
| entity_type | 20 | REGION in all 20 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| query | string | Yes | Location query | London | |
| limit | integer | No | Maximum suggestions to return (default 10, max 20) | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/rightmove/autocomplete?query=London&limit=10" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"query": "London",
"results": [
{
"id": "REGION^87490",
"name": "London",
"entity_type": "REGION"
},
{
"id": "POSTCODE^SW1A 1AA",
"name": "SW1A 1AA",
"entity_type": "POSTCODE"
}
]
}
}Request schema
No body schema
Response schema
Inline response schema
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | Code is the HTTP status code or a custom code used to indicate the result of the request @example 200 | |||
| data | rightmove.AutocompleteResponse | No | ||||
| data.query | string | No | London | |||
| data.results | array | No | ||||
| data.results[].entity_type | string | No | REGION | |||
| data.results[].full_name | string | No | London, Greater London, England | |||
| data.results[].id | string | No | REGION^12345 | |||
| data.results[].name | string | No | London, Greater London | |||
| msg | unknown | No | Msg is the message that describes the result of the request @example "Request successful" |
| Status | Description | Schema |
|---|---|---|
| 400 | Invalid query parameter | #/definitions/app.Response |
| 500 | Internal server error | #/definitions/app.Response |
| 503 | Upstream error | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/rightmove/autocomplete?query=London&limit=10" \
-H "x-api-key: $CRAWLORA_API_KEY"