Skip to main content
POST
Search UK homes for sale or rent
  • Endpoint: rightmove.search
  • Returns: data has listings, total.
  • Cost: 1 credit per 24 items, at least 1 credit. Failed calls cost nothing.
  • Paging: Yes. Send the cursor from the response to get the next page. See Paging.

Example

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
location
string
required
Required string length: 2 - 200
status
enum<string>
default:forSale
Available options:
forSale,
forRent
sort
enum<string>
default:newest
Available options:
newest,
oldest,
priceHigh,
priceLow
radiusKm
number
Required range: 0 <= x <= 65
price
object
bedrooms
object
propertyTypes
enum<string>[]
Minimum array length: 1
Available options:
detached,
semiDetached,
terraced,
flat,
bungalow,
land,
parkHome
mustHave
enum<string>[]
Minimum array length: 1
Available options:
garden,
parking,
newHome,
retirement,
sharedOwnership,
auction
within
enum<string>
default:all
Available options:
day,
threeDays,
week,
twoWeeks,
all
includeUnderOffer
boolean
default:false
queries
string[]
Required array length: 1 - 10 elements
Required string length: 1 - 60
limit
integer
default:24
Required range: 1 <= x <= 240
cursor
string
Pattern: ^(?:\d{1,4}~(?:\d{1,3})?|(?:\d{1,3}))$

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required