# OpenRent Search API Documentation

<p><strong>OpenRent Search API</strong> 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.</p>

- **Documentation:** [https://scrappa.co/docs/openrent-api/openrent_search](https://scrappa.co/docs/openrent-api/openrent_search)
- **API group:** OpenRent API
- **Endpoint:** `GET https://scrappa.co/api/openrent/search`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `location` | string | Yes | Place name or postcode, e.g. Leeds. Use the autocomplete endpoint for valid names. |
| `min_price` | integer | No | Minimum rent in GBP per month. |
| `max_price` | integer | No | Maximum rent in GBP per month. |
| `min_bedrooms` | integer | No | Minimum number of bedrooms. |
| `max_bedrooms` | integer | No | Maximum number of bedrooms. |
| `min_bathrooms` | integer | No | Minimum number of bathrooms. |
| `max_bathrooms` | integer | No | Maximum number of bathrooms. |
| `property_type` | string | No | house, flat or room. |
| `furnished` | string | No | furnished, unfurnished or any (default). Part-furnished listings match only any. |
| `pets_allowed` | boolean | No | true to list only properties that accept pets. |
| `students_allowed` | boolean | No | true to list only properties that accept students. |
| `families_allowed` | boolean | No | true to list only properties that accept families. |
| `dss_accepted` | boolean | No | true to list only properties where DSS/LHA covers the rent. |
| `bills_included` | boolean | No | true to list only properties with bills included. |
| `has_garden` | boolean | No | true to list only properties with a garden. |
| `has_parking` | boolean | No | true to list only properties with parking. |
| `has_fireplace` | boolean | No | true to list only properties with a fireplace. |
| `has_video` | boolean | No | true to list only properties with a video tour. |
| `live_only` | boolean | No | true (default) hides let-agreed properties. false includes them. |
| `available_before` | string | No | Date YYYY-MM-DD. Only properties available on or before it. |
| `max_min_tenancy` | integer | No | Maximum preferred minimum tenancy in months. |
| `sort` | string | No | relevance (default), price_asc, price_desc, newest or distance. |
| `page` | integer | No | One-based page number. 20 listings per page. Defaults to 1. |

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 422 | Validation Error | A public parameter is missing or invalid. This response is not billable. |
| 404 | Not Found | OpenRent has no such location, property or landlord. This response is not billable. |
| 503 | Service Unavailable | OpenRent is temporarily unavailable. This response is not billable and can be retried. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)
