/rightmove/properties/search

POST /api/rightmove/properties/search

Price: 10 credits

Search Rightmove properties for sale or to rent within a location. Returns property cards: id, url, address, summary, property sub-type, bedroom/bathroom counts, price, coordinates, images, tenure, listing dates and the marketing branch. Filter by radius, price range, bedrooms, property type and sort order.

How to use it

Search Rightmove properties within a location. Provide location_id from the rightmove/locations/search endpoint (e.g. REGION^87490) and transaction_type (sale or rent). Each result has id (feed to rightmove/properties for full detail), url, display_address, summary, property_sub_type, property_type_description, transaction_type, channel, bedroom_count, bathroom_count, price (numeric) and display_price/price_qualifier/price_frequency, latitude/longitude, image+images, image_count, floorplan_count, tenure_type, added_or_reduced, listing_update_reason/date, first_visible_date, let_available_date, is_premium, is_featured and the marketing branch (branch_id, branch_display_name, branch_phone, branch_image). Narrow with radius (miles), min_price/max_price (GBP; per month for rentals), min_bedrooms/max_bedrooms, property_type and sort.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location_id string required — Rightmove location identifier from the locations/search endpoint (e.g. REGION^87490, OUTCODE^2522, POSTCODE^123, BRANCH^226316). (examples: "REGION^87490", "OUTCODE^2522"; minLength: 3)
• transaction_type string required — Whether to search properties for sale or to rent. (one of: "sale", "rent")
• count integer required — Max number of results to return (min: 1)
• radius number nullable — Search radius in miles around the location. (min: 0)
• min_price integer nullable — Minimum price (GBP). For rentals this is per month. (min: 0)
• max_price integer nullable — Maximum price (GBP). For rentals this is per month. (min: 0)
• min_bedrooms integer nullable — Minimum number of bedrooms. (min: 0)
• max_bedrooms integer nullable — Maximum number of bedrooms. (min: 0)
• property_type string nullable — Restrict results to a property type. (one of: "any", "houses", "flats", "bungalows", "land", "commercial", "other", "detached", "semi-detached", "terraced", "park-home")
• sort string — Result ordering. (default: "most_recent"; one of: "most_recent", "price_high", "price_low", "oldest")

Response

• @type string (default: "RightmoveSearchProperty")
• id string required
• url string nullable
• display_address string nullable
• summary string nullable
• property_sub_type string nullable
• property_type_description string nullable
• transaction_type string nullable
• channel string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• price integer nullable
• display_price string nullable
• price_qualifier string nullable
• price_frequency string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• image_count integer nullable
• floorplan_count integer nullable
• tenure_type string nullable
• added_or_reduced string nullable
• listing_update_reason string nullable
• listing_update_date string nullable
• first_visible_date string nullable
• let_available_date string nullable
• is_premium boolean nullable
• is_featured boolean nullable
• branch_id integer nullable
• branch_display_name string nullable
• branch_phone string nullable
• branch_image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Location not found or no properties matched Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.