Skip to content
Scrappa Get API key
OpenRent API 1 credit/request

OpenRent Property API Documentation

GET https://scrappa.co/api/openrent/property

OpenRent Property API returns one rental listing: title, description, rent, deposit, bills, tenant preferences (students, families, pets, smokers, DSS), availability, minimum tenancy, online viewings, features, furnishing, EPC rating, coordinates, all photos, local transport, nearby schools and a landlord summary with response rate and response time. Street address and floor area are not published by OpenRent and are returned as null.

OpenRent Property API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/openrent/property
Auth header
x-api-key
Cost
1 credit/request
id = 1234567890
Response preview
200 OK
{
    "data": {
        "listing": {
            "id": 2940468,
            "url": "https://www.openrent.co.uk/property-to-rent/london/1-bed-flat-charring-cross-prime-location-wc2n/2940468",
            "city": "London",
            "title": "1 Bed Flat, Charring Cross Prime Location, WC2N",
            "images": [
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p7u21r4uq8r1kom6uo4a58.JPG",
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p9d51du81qo10cjkpl47gb.JPG",
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p9tdq4una7clrm75jmrc.JPG"
            ],
            "address": null,
            "deposit": 669.23,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

id integer Required

Property id from the search endpoint, e.g. 2940468.

Example value 1234567890

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

data meta success
JSON Response
200 OK
{
    "data": {
        "listing": {
            "id": 2940468,
            "url": "https://www.openrent.co.uk/property-to-rent/london/1-bed-flat-charring-cross-prime-location-wc2n/2940468",
            "city": "London",
            "title": "1 Bed Flat, Charring Cross Prime Location, WC2N",
            "images": [
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p7u21r4uq8r1kom6uo4a58.JPG",
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p9d51du81qo10cjkpl47gb.JPG",
                "https://imagescdn.openrent.co.uk/listings/2940468/o_1jri9p9tdq4una7clrm75jmrc.JPG"
            ],
            "address": null,
            "deposit": 669.23,
            "outcode": "WC2N",
            "schools": [
                {
                    "name": "The Royal Ballet School",
                    "levels": [
                        "Secondary",
                        "Post-16"
                    ],
                    "distance_km": 0.7,
                    "walk_minutes": 10
                },
                {
                    "name": "St Clement Danes CofE Primary School",
                    "levels": [
                        "Nursery",
                        "Primary"
                    ],
                    "distance_km": 0.8,
                    "walk_minutes": 12
                }
            ],
            "area_sqm": null,
            "bedrooms": 1,
            "currency": "GBP",
            "landlord": {
                "id": 7829841,
                "url": "https://www.openrent.co.uk/search/searchbylandlord?landlordID=7829841",
                "name": "Realty L.",
                "avatar_url": "https://imagescdn.openrent.co.uk/userPhotos/7829841/71a4e44b49.JPG_t.JPG",
                "member_since": "March 2025",
                "response_rate": 99,
                "response_time": "Within 2 Days",
                "email_verified": true,
                "phone_verified": false
            },
            "latitude": 51.50738,
            "location": "London, WC2N",
            "bathrooms": 1,
            "longitude": -0.1244289,
            "transport": [
                {
                    "mode": "Underground",
                    "name": "Charing Cross",
                    "walk_minutes": 2
                },
                {
                    "mode": "National Rail",
                    "name": "London Charing Cross",
                    "walk_minutes": 2
                },
                {
                    "mode": "Underground",
                    "name": "Embankment",
                    "walk_minutes": 4
                },
                {
                    "mode": "Underground",
                    "name": "Leicester Square",
                    "walk_minutes": 10
                }
            ],
            "epc_rating": "C",
            "furnishing": "Furnished",
            "has_garden": false,
            "description": "All Bills Included \u2013 Spacious 1-Bed Flat in Central London!\nLooking for a comfortable home in the heart of London? This bright and spacious 1-bedroom flat offers the perfect mix of space, convenience, and character.\nSet within a charming co\u2026",
            "has_parking": false,
            "max_tenants": 1,
            "dss_accepted": false,
            "pets_allowed": false,
            "has_fireplace": false,
            "available_from": "2027-01-05",
            "bills_included": true,
            "rent_per_month": 2850,
            "online_viewings": true,
            "smokers_allowed": true,
            "families_allowed": false,
            "students_allowed": true,
            "minimum_tenancy_months": 6
        }
    },
    "meta": {
        "billable": true,
        "duration_ms": 1210,
        "endpoint_family": "property"
    },
    "success": true
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A public parameter is missing or invalid. This response is not billable.

{
    "errors": {
        "id": [
            "The id field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Not Found

OpenRent has no such location, property or landlord. This response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "duration_ms": 900,
        "endpoint_family": "property"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested OpenRent resource was not found."
    },
    "success": false
}
503

Service Unavailable

OpenRent is temporarily unavailable. This response is not billable and can be retried.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "duration_ms": 4200,
        "endpoint_family": "property"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "OpenRent is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.