API reference

Zoopla Property API

One listing's page: title, address and UPRN, rooms and floor area, price with its qualifier and price per square foot, tenure, the portal's key facts (service charge, council tax, water…), EPC rating, description and features, photos, floorplans, transport and schools nearby, price history and the agent branch.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/zoopla/propertylive · proven3 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`id`	yes	The listing number (or pass url, the listing's page)	`69200045`
`url`	no	The listing's page URL instead of an id
`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/property?id=69200045" \
  -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/property?id=69200045",
  { 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/property?id=69200045",
    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/property",
  "data": {
    "_warnings": [],
    "address": "example",
    "agent": {
      "id": "example",
      "logo_url": "https://example.com/example",
      "member_type": "example",
      "name": "example",
      "phone": "example",
      "url": "https://example.com/example"
    },
    "auction": false,
    "bathrooms": 0,
    "bedrooms": 0,
    "brochures": [],
    "category": "example",
    "chain_free": false,
    "condition": "example",
    "currency": "example",
    "description": "example",
    "details": [
      {
        "key": "example",
        "title": "example",
        "value": "example"
      }
    ],
    "epc_rating": "example",
    "epcs": [
      {
        "url": "https://example.com/example"
      }
    ],
    "floor_area": {
      "label": "example",
      "source": "example",
      "units": "example",
      "value": 0
    },
    "floorplans": [
      {
        "url": "https://example.com/example"
      }
    ],
    "highlights": [],
    "id": "example",
    "image_count": 0,
    "key_features": [
      "example"
    ],
    "latitude": 0,
    "living_rooms": 0,
    "longitude": 0,
    "outcode": "example",
    "photos": [
      {
        "caption": "example",
        "url": "https://example.com/example"
      }
    ],
    "platform": "example",
    "points_of_interest": [],
    "postcode": "example",
    "price": 0,
    "price_history": {
      "changes": []
    },
    "price_label": "example",
    "price_per_area": "example",
    "price_qualifier": "example",
    "property_type": "example",
    "published_at": "2026-09-01T12:00:00Z",
    "retirement_home": false,
    "shared_ownership": false,
    "status": "example",
    "street": "example",
    "tags": [
      "example"
    ],
    "tenure": "example",
    "title": "example",
    "town": "example",
    "transaction": "example",
    "transports": [
      {
        "distance_miles": 0,
        "name": "example",
        "type": "example"
      }
    ],
    "type": "example",
    "uprn": "example",
    "url": "https://example.com/example"
  },
  "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.
`address`	`string \| null`	Optional address supplied by this operation. Null means unknown.
`agent`	`object \| null`	Optional agent supplied by this operation. Null means unknown.
`agent.id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`agent.logo_url`	`string \| null`	Optional logo url supplied by this operation. Null means unknown.
`agent.member_type`	`string \| null`	Optional member type supplied by this operation. Null means unknown.
`agent.name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`agent.phone`	`string \| null`	Optional phone supplied by this operation. Null means unknown.
`agent.url`	`string \| null`	Original source URL when supplied.
`auction`	`boolean \| null`	Optional auction supplied by this operation. Null means unknown.
`bathrooms`	`number \| null`	Optional bathrooms supplied by this operation. Null means unknown.
`bedrooms`	`number \| null`	Optional bedrooms supplied by this operation. Null means unknown.
`brochures`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`category`	`string \| null`	Optional category supplied by this operation. Null means unknown.
`chain_free`	`boolean \| null`	Optional chain free supplied by this operation. Null means unknown.
`condition`	`string \| null`	Optional condition supplied by this operation. Null means unknown.
`currency`	`string \| null`	Optional currency supplied by this operation. Null means unknown.
`description`	`string \| null`	Source description; null or absent means not supplied.
`details`	`array \| null`	Optional details supplied by this operation. Null means unknown.
`details[].key`	`string \| null`	Optional key supplied by this operation. Null means unknown.
`details[].title`	`string \| null`	Source title when supplied.
`details[].value`	`string \| null`	Optional value supplied by this operation. Null means unknown.
`epc_rating`	`string \| null`	Optional epc rating supplied by this operation. Null means unknown.
`epcs`	`array \| null`	Optional epcs supplied by this operation. Null means unknown.
`epcs[].url`	`string \| null`	Original source URL when supplied.
`floor_area`	`object \| null`	Optional floor area supplied by this operation. Null means unknown.
`floor_area.label`	`string \| null`	Optional label supplied by this operation. Null means unknown.
`floor_area.source`	`string \| null`	Optional source supplied by this operation. Null means unknown.
`floor_area.units`	`string \| null`	Optional units supplied by this operation. Null means unknown.
`floor_area.value`	`number \| null`	Optional value supplied by this operation. Null means unknown.
`floorplans`	`array \| null`	Optional floorplans supplied by this operation. Null means unknown.
`floorplans[].url`	`string \| null`	Original source URL when supplied.
`highlights`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`image_count`	`number \| null`	Optional image count supplied by this operation. Null means unknown.
`key_features`	`array \| null`	Optional key features supplied by this operation. Null means unknown.
`latitude`	`number \| null`	Optional latitude supplied by this operation. Null means unknown.
`living_rooms`	`number \| null`	Optional living rooms supplied by this operation. Null means unknown.
`longitude`	`number \| null`	Optional longitude supplied by this operation. Null means unknown.
`outcode`	`string \| null`	Optional outcode supplied by this operation. Null means unknown.
`photos`	`array \| null`	Optional photos supplied by this operation. Null means unknown.
`photos[].caption`	`string \| null`	Optional caption supplied by this operation. Null means unknown.
`photos[].url`	`string \| null`	Original source URL when supplied.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`points_of_interest`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`postcode`	`string \| null`	Optional postcode supplied by this operation. Null means unknown.
`price`	`number \| null`	Source price. Currency, taxes and availability depend on the listing.
`price_history`	`object \| null`	Optional price history supplied by this operation. Null means unknown.
`price_history.changes`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`price_label`	`string \| null`	Optional price label supplied by this operation. Null means unknown.
`price_per_area`	`string \| null`	Optional price per area supplied by this operation. Null means unknown.
`price_qualifier`	`string \| null`	Optional price qualifier supplied by this operation. Null means unknown.
`property_type`	`string \| null`	Optional property type supplied by this operation. Null means unknown.
`published_at`	`string \| null`	Source publication time when available.
`retirement_home`	`boolean \| null`	Optional retirement home supplied by this operation. Null means unknown.
`shared_ownership`	`boolean \| null`	Optional shared ownership supplied by this operation. Null means unknown.
`status`	`string \| null`	Optional status supplied by this operation. Null means unknown.
`street`	`string \| null`	Optional street supplied by this operation. Null means unknown.
`tags`	`array \| null`	Optional tags supplied by this operation. Null means unknown.
`tenure`	`string \| null`	Optional tenure supplied by this operation. Null means unknown.
`title`	`string \| null`	Source title when supplied.
`town`	`string \| null`	Optional town supplied by this operation. Null means unknown.
`transaction`	`string \| null`	Optional transaction supplied by this operation. Null means unknown.
`transports`	`array \| null`	Optional transports supplied by this operation. Null means unknown.
`transports[].distance_miles`	`number \| null`	Optional distance miles supplied by this operation. Null means unknown.
`transports[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`transports[].type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`uprn`	`string \| null`	Optional uprn supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.

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 Property API

Query parameters

Make the request

Response fields and example

More Zoopla reference

First call in under a minute