Zoopla API

Zoopla homes to rent

Homes to rent in an area: address, title, rooms, monthly rent and its label, available-from date, agent, photos and position; the portal's featured homes beside them.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/zoopla/search-rentlive · proven3 credits

Try in Playground

Parameters

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 and label)	`Oxford`
`identifier`	no	An area identifier from zoopla/locations	`oxford`
`label`	no	The area's label from zoopla/locations, sent with the identifier	`Oxford, Oxfordshire`
`page`	no	Page number	`1`
`radius`	no	Miles around the area: 0, 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40
`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
`min_bathrooms`	no	Minimum bathrooms
`max_bathrooms`	no	Maximum bathrooms
`property_type`	no	detached, semi_detached, terraced, flats, bungalow; several separated by commas	`flats`
`sort`	no	newest, highest_price, lowest_price or most_reduced	`newest`
`keywords`	no	Words the listing must mention
`must_have`	no	has_garden, has_parking_garage, has_balcony_terrace and the portal's other must-haves; separated by commas
`features`	no	The portal's property-feature codes, separated by commas
`added`	no	Only homes added in the last 1, 3, 7, 14 or 30 days
`include_rented`	no	Include homes already let or let agreed	`false`
`furnished`	no	any, furnished, part_furnished or unfurnished
`available_from`	no	now, 1months, 3months, 6months or 12months
`retirement_homes`	no	include, exclude or only
`house_share`	no	include, exclude or only
`student`	no	Student accommodation: include, exclude or only
`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

curl "https://www.monocrawl.com/v1/zoopla/search-rent" \
  -H "x-api-key: mn_your_key_here"

TypeScript

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/zoopla/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

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/zoopla/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.

200 · application/json

{
  "success": true,
  "platform": "zoopla",
  "endpoint": "/v1/zoopla/search-rent",
  "data": {
    "_warnings": [],
    "channel": "example",
    "count": 0,
    "cursor": null,
    "extended": [],
    "featured": [],
    "has_more": false,
    "items": [
      {
        "address": "example",
        "agent": {
          "id": "example",
          "logo_url": "https://example.com/example",
          "name": "example",
          "phone": "example",
          "url": "https://example.com/example"
        },
        "alternative_price_label": "example",
        "available_from": "example",
        "bathrooms": 0,
        "bedrooms": 0,
        "currency": "example",
        "flag": "example",
        "floor_area": {
          "label": "example",
          "source": "example",
          "units": "example",
          "value": 0
        },
        "floorplan_count": 0,
        "highlights": [],
        "id": "example",
        "image_count": 0,
        "image_url": "https://example.com/example",
        "images": [
          "example"
        ],
        "listed_on": "example",
        "living_rooms": 0,
        "platform": "example",
        "premium": false,
        "price": 0,
        "price_label": "example",
        "property_type": "example",
        "short_price": "example",
        "summary": "example",
        "tags": [
          "example"
        ],
        "title": "example",
        "transports": [],
        "type": "example",
        "under_offer": false,
        "url": "https://example.com/example",
        "video_count": 0
      }
    ],
    "location": {
      "identifier": "example",
      "name": "example"
    },
    "page": 0,
    "pages": 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
`_warnings`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`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.
`extended`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`featured`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`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.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[].agent.url`	`string \| null`	Original source URL when supplied.
`items[].alternative_price_label`	`string \| null`	Optional alternative price label supplied by this operation. Null means unknown.
`items[].available_from`	`string \| null`	Optional available from supplied by this operation. Null means unknown.
`items[].bathrooms`	`number \| null`	Optional bathrooms supplied by this operation. Null means unknown.
`items[].bedrooms`	`number \| null`	Optional bedrooms supplied by this operation. Null means unknown.
`items[].currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`items[].flag`	`string \| null`	Optional flag supplied by this operation. Null means unknown.
`items[].floor_area`	`object \| null`	Optional floor area supplied by this operation. Null means unknown.
`items[].floor_area.label`	`string \| null`	Optional label supplied by this operation. Null means unknown.
`items[].floor_area.source`	`string \| null`	Optional source supplied by this operation. Null means unknown.
`items[].floor_area.units`	`string \| null`	Optional units supplied by this operation. Null means unknown.
`items[].floor_area.value`	`number \| null`	Optional value supplied by this operation. Null means unknown.
`items[].floorplan_count`	`number \| null`	Optional floorplan count supplied by this operation. Null means unknown.
`items[].highlights`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`items[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`items[].image_count`	`number \| null`	Optional image count supplied by this operation. Null means unknown.
`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[].listed_on`	`string \| null`	Optional listed on supplied by this operation. Null means unknown.
`items[].living_rooms`	`number \| null`	Optional living rooms 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[].property_type`	`string \| null`	Optional property type supplied by this operation. Null means unknown.
`items[].short_price`	`string \| null`	Optional short price supplied by this operation. Null means unknown.
`items[].summary`	`string \| null`	Optional summary supplied by this operation. Null means unknown.
`items[].tags`	`array \| null`	Optional tags supplied by this operation. Null means unknown.
`items[].title`	`string \| null`	Source title when supplied.
`items[].transports`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`items[].type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`items[].under_offer`	`boolean \| null`	Optional under offer supplied by this operation. Null means unknown.
`items[].url`	`string \| null`	Original source URL when supplied.
`items[].video_count`	`number \| null`	Optional video count supplied by this operation. Null means unknown.
`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.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`page`	`number \| null`	Optional page supplied by this operation. Null means unknown.
`pages`	`number \| null`	Optional pages 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

Zoopla homes to rent

Query parameters

Make the request

Response fields and example

More Zoopla reference

First call in under a minute