Rightmove Estate Agents API

Parameters

Query parameters

Examples

Make the request

curl "https://www.monocrawl.com/v1/rightmove/agents" \
  -H "x-api-key: mn_your_key_here"

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/agents",
  { 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);

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/rightmove/agents",
    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/agents",
  "data": {
    "count": 0,
    "cursor": null,
    "has_more": false,
    "items": [
      {
        "branch": "example",
        "description": "example",
        "display_name": "example",
        "estate_agent": false,
        "id": "example",
        "lettings": false,
        "logo_url": "https://example.com/example",
        "name": "example",
        "phones": [
          {}
        ],
        "platform": "example",
        "sales": false,
        "summary": "example",
        "type": "example",
        "url": "https://example.com/example"
      }
    ],
    "location": {
      "identifier": "example",
      "name": "example",
      "type": "example"
    },
    "page": 0,
    "total": 0
  },
  "credits_used": 2,
  "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.

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

Related

Useful next calls

• All Rightmove operations →
• Browse the complete endpoint directory →
• OpenAPI JSON →