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

OpenRent Search API Documentation

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

OpenRent Search API returns current UK rental listings from OpenRent, a landlord-direct portal. Filter by location, rent, bedrooms, bathrooms, property type, furnishing, tenant preferences, features and availability, sort by price, newest or distance, and page through the results (20 per page). Every listing carries the id, URL, title, description, monthly and weekly rent, rooms, type, tenant flags, features, listing date, availability date, minimum tenancy, coordinates, thumbnail and let-agreed status. Filters are always honoured and page N is the real Nth slice. OpenRent lists rentals only; there are no sale listings. A valid search with no matches is a successful, empty response.

OpenRent Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/openrent/search
Auth header
x-api-key
Cost
1 credit/request
location = Austin, Texas
Response preview
200 OK
{
    "data": {
        "listings": [
            {
                "id": 883174,
                "url": "https://www.openrent.co.uk/883174",
                "title": "2 Bed Flat, Woodhouse, LS3",
                "is_new": false,
                "bedrooms": 2,
                "currency": "GBP",
                "latitude": 53.80195,
                "bathrooms": 2,
                "furnished": "furnished",
                "has_video": false,
...

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.

22 optional filters available.

location string Required

Place name or postcode, e.g. Leeds. Use the autocomplete endpoint for valid names.

Example value Austin, Texas
min_price integer Optional

Minimum rent in GBP per month.

Example value 10
max_price integer Optional

Maximum rent in GBP per month.

Example value 10
min_bedrooms integer Optional

Minimum number of bedrooms.

Example value 10
max_bedrooms integer Optional

Maximum number of bedrooms.

Example value 10
min_bathrooms integer Optional

Minimum number of bathrooms.

Example value 10
max_bathrooms integer Optional

Maximum number of bathrooms.

Example value 10
property_type string Optional

house, flat or room.

Example value example
furnished string Optional

furnished, unfurnished or any (default). Part-furnished listings match only any.

Example value example
pets_allowed boolean Optional

true to list only properties that accept pets.

Example value true
students_allowed boolean Optional

true to list only properties that accept students.

Example value true
families_allowed boolean Optional

true to list only properties that accept families.

Example value true
dss_accepted boolean Optional

true to list only properties where DSS/LHA covers the rent.

Example value true
bills_included boolean Optional

true to list only properties with bills included.

Example value true
has_garden boolean Optional

true to list only properties with a garden.

Example value true
has_parking boolean Optional

true to list only properties with parking.

Example value true
has_fireplace boolean Optional

true to list only properties with a fireplace.

Example value true
has_video boolean Optional

true to list only properties with a video tour.

Example value true
live_only boolean Optional

true (default) hides let-agreed properties. false includes them.

Example value true
available_before string Optional

Date YYYY-MM-DD. Only properties available on or before it.

Example value example
max_min_tenancy integer Optional

Maximum preferred minimum tenancy in months.

Example value 10
sort string Optional

relevance (default), price_asc, price_desc, newest or distance.

Example value relevance
page integer Optional

One-based page number. 20 listings per page. Defaults to 1.

Example value 1

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": {
        "listings": [
            {
                "id": 883174,
                "url": "https://www.openrent.co.uk/883174",
                "title": "2 Bed Flat, Woodhouse, LS3",
                "is_new": false,
                "bedrooms": 2,
                "currency": "GBP",
                "latitude": 53.80195,
                "bathrooms": 2,
                "furnished": "furnished",
                "has_video": false,
                "is_shared": false,
                "is_studio": false,
                "listed_at": "2026-10-15T13:09:30+00:00",
                "longitude": -1.5586894,
                "has_garden": true,
                "let_agreed": false,
                "description": "A modern 2 ensuite bedroom apartment overlooking Hanover Square. Located on the edge of the city centre and 10 minutes to t",
                "has_parking": true,
                "is_featured": false,
                "dss_accepted": false,
                "pets_allowed": false,
                "has_fireplace": false,
                "property_type": "flat",
                "rent_per_week": 253.84617337278257,
                "thumbnail_url": "https://imagescdn.openrent.co.uk/listings/883174/o_1k4vqeffm3vggo41qaffkc1mng1.JPG_homepage.JPG",
                "available_from": "2026-10-15",
                "bills_included": false,
                "distance_miles": 0.44,
                "rent_per_month": 1100,
                "featured_photos": [],
                "families_allowed": true,
                "students_allowed": true,
                "minimum_tenancy_months": 0,
                "video_viewings_accepted": false
            },
            {
                "id": 2980706,
                "url": "https://www.openrent.co.uk/2980706",
                "title": "2 Bed Flat, Wellington Street, LS1",
                "is_new": false,
                "bedrooms": 2,
                "currency": "GBP",
                "latitude": 53.7959,
                "bathrooms": 2,
                "furnished": "furnished",
                "has_video": true,
                "is_shared": false,
                "is_studio": false,
                "listed_at": "2026-07-25T12:46:11+00:00",
                "longitude": -1.5533814,
                "has_garden": false,
                "let_agreed": false,
                "description": "Overview  A flagship, high-floor 2 bedroom, 2 bathroom apartment in the heart of Leeds city centre, offering exceptional sp",
                "has_parking": false,
                "is_featured": false,
                "dss_accepted": false,
                "pets_allowed": true,
                "has_fireplace": false,
                "property_type": "flat",
                "rent_per_week": 321.92310168639244,
                "thumbnail_url": "https://imagescdn.openrent.co.uk/listings/2673111/2673111StreetViewPhoto0c25cba4-d62a-4cde-b736-7d29513c3a75.JPG_homepage.JPG",
                "available_from": "2026-07-25",
                "bills_included": false,
                "distance_miles": 0.54,
                "rent_per_month": 1395,
                "featured_photos": [],
                "families_allowed": true,
                "students_allowed": true,
                "minimum_tenancy_months": 6,
                "video_viewings_accepted": false
            }
        ],
        "search_metadata": {
            "page": 1,
            "slug": "leeds",
            "sort": "price_asc",
            "has_more": false,
            "location": "Leeds",
            "page_size": 20,
            "total_results": 7,
            "applied_filters": {
                "live_only": true,
                "min_bedrooms": 2
            }
        }
    },
    "meta": {
        "billable": true,
        "duration_ms": 1840,
        "endpoint_family": "search"
    },
    "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": {
        "location": [
            "The location 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": "search"
    },
    "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": "search"
    },
    "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.