Rightmove

get/rightmove/search

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/rightmove/search
  • Auth: API key in header X-API-KEY

Query parameters

locationstring nullable

Place name to search, e.g. "London". Resolved to a location identifier for you. The first search for a given name resolves it and costs 2 API requests; the resolution is cached, so later searches cost 1. Pass location_identifier instead to always cost 1.

location_identifierstring nullable

A resolved identifier such as REGION^87490. Always costs 1 API request.

location_namestring nullable

Optional display name sent alongside the identifier so the listing cards show a place. Ignored when location_identifier is omitted.

channel'BUY' | 'RENT' | 'COMMERCIAL_BUY' | 'COMMERCIAL_RENT' required

BUY, RENT, COMMERCIAL_BUY or COMMERCIAL_RENT.

radiusinteger nullable

Search radius in miles.

pageinteger nullable

Page number, 1 to 41.

sortinteger nullable

Sort order, e.g. 2 for newest first.

min_priceinteger nullable

Minimum price filter, applied upstream.

max_priceinteger nullable

Maximum price filter, applied upstream.

min_bedroomsinteger nullable

Minimum number of bedrooms.

max_bedroomsinteger nullable

Maximum number of bedrooms.

property_typestring nullable

Property type filter, applied upstream, for example FLAT, HOUSE or BUNGALOW.

must_havestring nullable

Required feature filter, applied upstream. For example garden, parking or garage.

enrichboolean nullable

Set to 1 to merge the mobile listing family into every result for rent cadence, listing status, thumbnail and floorplan counts, and the inline branch contact. This opt-in search costs 2 API requests instead of 1, and 3 the first time a given place name has to be resolved. Commercial channels have no mobile family, so enrich is a no-op there and costs the same as a plain search.

Response

Changes

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