Rightmove API
Rightmove homes to rent
Homes to rent in an area: address, type, bedrooms, monthly rent and its labels, agent, photos, position and when it was listed; the portal's featured homes beside them.
Endpoint
/v1/rightmove/search-rentlive · proven3 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
location | no | A postcode, town or area name; resolved to the portal's identifier once and remembered (or pass identifier) | Manchester |
identifier | no | An area identifier from rightmove/locations | REGION^87490 |
page | no | Page number | 1 |
limit | no | Results per page, 1 to 100 | 25 |
radius | no | Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40 | 1 |
min_price | no | Minimum monthly rent in pounds | |
max_price | no | Maximum monthly rent in pounds | |
min_bedrooms | no | Minimum bedrooms | |
max_bedrooms | no | Maximum bedrooms | |
property_type | no | detached, semi-detached, terraced, flat, bungalow; several separated by commas | flat |
sort | no | newest, oldest, highest_price or lowest_price | newest |
keywords | no | Words to prioritise, separated by commas | |
must_have | no | garden, parking, houseShare, retirement, student; separated by commas | |
dont_show | no | houseShare, retirement, student; separated by commas | |
furnished | no | furnished, partFurnished, unfurnished; separated by commas | |
let_type | no | longTerm or shortTerm | |
include_let_agreed | no | Include homes already let agreed | false |
added | no | Only homes added in the last 1, 3, 7 or 14 days | |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/rightmove/search-rent" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/rightmove/search-rent",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/rightmove/search-rent",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "rightmove",
"endpoint": "/v1/rightmove/search-rent",
"data": {
"channel": "example",
"count": 0,
"cursor": null,
"featured": [
{
"address": "example",
"agent": {
"branch": "example",
"development": false,
"id": "example",
"logo_url": "https://example.com/example",
"name": "example",
"phone": "example"
},
"bedrooms": 0,
"build_to_rent": false,
"development": false,
"featured": false,
"floorplan_count": 0,
"has_video": false,
"id": "example",
"image_url": "https://example.com/example",
"images": [
"example"
],
"keywords": [],
"latitude": 0,
"listed_at": "2026-09-01T12:00:00Z",
"listing_update": "2026-09-01T12:00:00Z",
"longitude": 0,
"monthly_rent": 0,
"online_viewing": false,
"photo_count": 0,
"platform": "example",
"premium": false,
"price": 0,
"price_label": "example",
"price_labels": [
"example"
],
"property_type": "example",
"sticker": "example",
"summary": "example",
"type": "example",
"update_reason": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"url": "https://example.com/example"
}
],
"has_more": false,
"items": [
{
"address": "example",
"agent": {
"branch": "example",
"development": false,
"id": "example",
"logo_url": "https://example.com/example",
"name": "example",
"phone": "example"
},
"bedrooms": 0,
"build_to_rent": false,
"development": false,
"featured": false,
"floorplan_count": 0,
"has_video": false,
"id": "example",
"image_url": "https://example.com/example",
"images": [
"example"
],
"keywords": [],
"latitude": 0,
"listed_at": "2026-09-01T12:00:00Z",
"listing_update": "2026-09-01T12:00:00Z",
"longitude": 0,
"monthly_rent": 0,
"online_viewing": false,
"photo_count": 0,
"platform": "example",
"premium": false,
"price": 0,
"price_label": "example",
"price_labels": [
"example"
],
"property_type": "example",
"sticker": "example",
"summary": "example",
"type": "example",
"update_reason": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"url": "https://example.com/example"
}
],
"location": {
"identifier": "example",
"latitude": 0,
"longitude": 0,
"name": "example"
},
"page": 0,
"radius_miles": 0,
"total": 0
},
"credits_used": 3,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
channel | string | null | Optional channel supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
featured | array | null | Optional featured supplied by this operation. Null means unknown. |
featured[].address | string | null | Optional address supplied by this operation. Null means unknown. |
featured[].agent | object | null | Optional agent supplied by this operation. Null means unknown. |
featured[].agent.branch | string | null | Optional branch supplied by this operation. Null means unknown. |
featured[].agent.development | boolean | null | Optional development supplied by this operation. Null means unknown. |
featured[].agent.id | string | null | Source identifier. Preserve the supplied type and exact value. |
featured[].agent.logo_url | string | null | Optional logo url supplied by this operation. Null means unknown. |
featured[].agent.name | string | null | Optional name supplied by this operation. Null means unknown. |
featured[].agent.phone | string | null | Optional phone supplied by this operation. Null means unknown. |
featured[].bedrooms | number | null | Optional bedrooms supplied by this operation. Null means unknown. |
featured[].build_to_rent | boolean | null | Optional build to rent supplied by this operation. Null means unknown. |
featured[].development | boolean | null | Optional development supplied by this operation. Null means unknown. |
featured[].featured | boolean | null | Optional featured supplied by this operation. Null means unknown. |
featured[].floorplan_count | number | null | Optional floorplan count supplied by this operation. Null means unknown. |
featured[].has_video | boolean | null | Optional has video supplied by this operation. Null means unknown. |
featured[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
featured[].image_url | string | null | Optional image url supplied by this operation. Null means unknown. |
featured[].images | array | null | Optional images supplied by this operation. Null means unknown. |
featured[].keywords | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
featured[].latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
featured[].listed_at | string | null | Optional listed at supplied by this operation. Null means unknown. |
featured[].listing_update | string | null | Optional listing update supplied by this operation. Null means unknown. |
featured[].longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
featured[].monthly_rent | number | null | Optional monthly rent supplied by this operation. Null means unknown. |
featured[].online_viewing | boolean | null | Optional online viewing supplied by this operation. Null means unknown. |
featured[].photo_count | number | null | Optional photo count supplied by this operation. Null means unknown. |
featured[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
featured[].premium | boolean | null | Optional premium supplied by this operation. Null means unknown. |
featured[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
featured[].price_label | string | null | Optional price label supplied by this operation. Null means unknown. |
featured[].price_labels | array | null | Optional price labels supplied by this operation. Null means unknown. |
featured[].property_type | string | null | Optional property type supplied by this operation. Null means unknown. |
featured[].sticker | string | null | Optional sticker supplied by this operation. Null means unknown. |
featured[].summary | string | null | Optional summary supplied by this operation. Null means unknown. |
featured[].type | string | null | Optional type supplied by this operation. Null means unknown. |
featured[].update_reason | string | null | Optional update reason supplied by this operation. Null means unknown. |
featured[].updated_at | string | null | Optional updated at supplied by this operation. Null means unknown. |
featured[].url | string | null | Original source URL when supplied. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].address | string | null | Optional address supplied by this operation. Null means unknown. |
items[].agent | object | null | Optional agent supplied by this operation. Null means unknown. |
items[].agent.branch | string | null | Optional branch supplied by this operation. Null means unknown. |
items[].agent.development | boolean | null | Optional development supplied by this operation. Null means unknown. |
items[].agent.id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].agent.logo_url | string | null | Optional logo url supplied by this operation. Null means unknown. |
items[].agent.name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].agent.phone | string | null | Optional phone supplied by this operation. Null means unknown. |
items[].bedrooms | number | null | Optional bedrooms supplied by this operation. Null means unknown. |
items[].build_to_rent | boolean | null | Optional build to rent supplied by this operation. Null means unknown. |
items[].development | boolean | null | Optional development supplied by this operation. Null means unknown. |
items[].featured | boolean | null | Optional featured supplied by this operation. Null means unknown. |
items[].floorplan_count | number | null | Optional floorplan count supplied by this operation. Null means unknown. |
items[].has_video | boolean | null | Optional has video supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].image_url | string | null | Optional image url supplied by this operation. Null means unknown. |
items[].images | array | null | Optional images supplied by this operation. Null means unknown. |
items[].keywords | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
items[].latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
items[].listed_at | string | null | Optional listed at supplied by this operation. Null means unknown. |
items[].listing_update | string | null | Optional listing update supplied by this operation. Null means unknown. |
items[].longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
items[].monthly_rent | number | null | Optional monthly rent supplied by this operation. Null means unknown. |
items[].online_viewing | boolean | null | Optional online viewing supplied by this operation. Null means unknown. |
items[].photo_count | number | null | Optional photo count supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].premium | boolean | null | Optional premium supplied by this operation. Null means unknown. |
items[].price | number | null | Source price. Currency, taxes and availability depend on the listing. |
items[].price_label | string | null | Optional price label supplied by this operation. Null means unknown. |
items[].price_labels | array | null | Optional price labels supplied by this operation. Null means unknown. |
items[].property_type | string | null | Optional property type supplied by this operation. Null means unknown. |
items[].sticker | string | null | Optional sticker supplied by this operation. Null means unknown. |
items[].summary | string | null | Optional summary supplied by this operation. Null means unknown. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].update_reason | string | null | Optional update reason supplied by this operation. Null means unknown. |
items[].updated_at | string | null | Optional updated at supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
location | object | null | Optional location supplied by this operation. Null means unknown. |
location.identifier | string | null | Optional identifier supplied by this operation. Null means unknown. |
location.latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
location.longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
location.name | string | null | Optional name supplied by this operation. Null means unknown. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
radius_miles | number | null | Optional radius miles supplied by this operation. Null means unknown. |
total | number | null | Source-reported total; null is unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference