Rightmove

Get Rightmove location autocomplete suggestions

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.

get/rightmove/autocomplete

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/rightmove/autocomplete
  • Auth: API key in header x-api-key

Query parameters

querystring required

Location query

limitinteger

Maximum suggestions to return (default 10, max 20)

Headers

x-api-keystring required

API key required

Response

Autocomplete suggestions

codeinteger

Code is the HTTP status code or a custom code used to indicate the result of the request @example 200

msgunknown

Example response

{
  "data": {
    "query": "London",
    "results": [
      {
        "entity_type": "REGION",
        "full_name": "London, Greater London, England",
        "id": "REGION^12345",
        "name": "London, Greater London"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.