docs / rightmove
Rightmove
UK property listings for sale and to rent.
base /rightmove/v16 endpoints
post
/rightmove/v1/location_searchfreeresolve a text location to a Rightmove locationIdentifier (LOS typeahead)
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| query | required | — | Free-text place to resolve (town, postcode, station, region). |
| limit = 10 | optional | 1– | Max location matches to return. |
post
/rightmove/v1/search2 creditssearch listings; channel = buy|rent|commercial_sale|commercial_rent|student (default buy)
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| location | optional | — | Free-text location (auto-resolved to a Rightmove locationIdentifier). Provide this OR location_identifier. |
| location_identifier | optional | — | A Rightmove locationIdentifier from location_search (e.g. REGION^87490, OUTCODE^2522, BRANCH^45021). Provide this OR location. |
| channel = buy | optional | buy · rent · new_homes · commercial_sale · commercial_rent · student · for_sale · sale · to_rent · lettings · commercial · new_build | Rightmove channel to search (default buy). Canonical values + the listed aliases are accepted; any other value is rejected with this list. |
| for_rent | optional | — | Shortcut: true selects the rent channel when `channel` is not set. |
| max_pages = 1 | optional | 1– | How many 24-result pages to fetch and merge (ignored when fetch_all=true). |
| fetch_all | optional | — | Fetch every page up to Rightmove's ~1,000-result cap (overrides max_pages). |
| index = 0 | optional | 0– | Starting result offset; increments by 24 per page (0, 24, 48, ...). |
| filters | optional | — | Advanced: extra raw Rightmove search query params as a key->value map (e.g. minBedrooms, maxPrice, radius, propertyTypes) added verbatim to the query. |
post
/rightmove/v1/property_detail3 creditsfull property: description, EPC, nearest stations, sizings, floorplans, agent
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| property_id | required | — | Rightmove property id (the digits in a /properties/<id> URL or a search result's property_id). |
post
/rightmove/v1/agent1 creditestate-agent branch profile (+ that branch's live listings via BRANCH^id)
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| branch_url | optional | — | An estate-agent branch landing-page URL (full or path). Provide this OR branch_id. |
| branch_id | optional | — | Rightmove branch id — lists that branch's live stock via BRANCH^id. Provide this OR branch_url. |
| max_pages = 1 | optional | 1– | How many 24-result pages to fetch and merge (ignored when fetch_all=true). |
post
/rightmove/v1/similar2 creditslistings similar to a property (same area + price/bedroom band)
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| property_id | required | — | Rightmove property id (the digits in a /properties/<id> URL or a search result's property_id). |
post
/rightmove/v1/sold_prices2 creditssold/transaction history: by location (search) or per-property (detail_url|uuid). Land-Registry sold data with full per-address transaction history.
| Parameter | Allowed / range | Description | |
|---|---|---|---|
| location | optional | — | Area for sold-price history (postcode/outcode/town, e.g. 'SW9', 'KT2 5HF'). Provide this OR detail_url/uuid. |
| detail_url | optional | — | A house-prices detail URL for one property's sold history (alternative to location). |
| uuid | optional | — | A house-prices detail uuid for one property's sold history (alternative to location). |
| page = 1 | optional | 1– | 1-based page of sold-price results (area mode). |
Example request · location_search
curl -X POST https://api.reefapi.com/rightmove/v1/location_search \
-H "x-api-key: $REEF_KEY" \
-H "content-type: application/json" \
-d '{"query":"London"}'Response shape
{
"ok": true,
"data": { /* the result */ },
"meta": {
"latency_ms": 240,
"record_count": 12,
"completeness_pct": 100
},
"error": null
}