# SpareRoom UK Flatshare Budget & Radius Search (`dataspryva/spareroom-uk-flatshare-budget-and-radius-search`) Actor

Search SpareRoom.co.uk for rooms to rent by city, budget range and distance from the centre, or fetch specific listings by URL, returning rent, bills-included status, property type, landlord type and availability.

- **URL**: https://apify.com/dataspryva/spareroom-uk-flatshare-budget-and-radius-search.md
- **Developed by:** [Dataspryva](https://apify.com/dataspryva) (community)
- **Categories:** Real estate, Automation, Lead generation
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.49 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## SpareRoom UK Flatshare Budget & Radius Search

SpareRoom is the UK's busiest flatshare site. This actor turns its public room adverts into structured data. Run a location search with a monthly budget, radius and optional filters, or paste your own listing URLs to collect the full advert detail page.

Everything is collected from public, logged-out pages. No SpareRoom account, cookie or proxy setup is required.

### Modes

| Mode | What it does |
|---|---|
| `search` | Resolves a UK city, town, neighbourhood or postcode on SpareRoom, applies your filters and pages through the results. |
| `details` | Fetches one or more SpareRoom listing URLs and returns the full advert detail record. |

The old mode names `searchRooms`, `searchByCity`, `searchByBudget` and `roomDetails` are still accepted and mapped to the matching mode, so existing saved tasks keep working.

### Input

| Field | Type | Default | Description |
|---|---|---|---|
| `mode` | select | `search` | `search` or `details`; legacy mode names are accepted |
| `city` | text | `London` | UK city, area, postcode or `/flatshare/...` URL |
| `maxItems` | integer | `20` | Maximum listings to return (1–1000) |
| `maxBudget` | integer | `1500` | Maximum monthly rent in GBP |
| `minBudget` | integer | – | Minimum monthly rent in GBP |
| `milesFromCenter` | integer | `3` | Search radius in miles |
| `roomType` | select | `any` | any, double, single, ensuite or studio |
| `propertyType` | select | `any` | any, roomsInShares, studios or wholeProperties |
| `billsIncluded` | boolean | `false` | Bills included only |
| `furnished` | select | `any` | any, furnished or unfurnished |
| `postedBy` | select | `any` | any, privateLandlords, flatmates, liveIn or noLiveIn |
| `sortBy` | select | `relevance` | relevance, newest, lastUpdated, priceLow or priceHigh |
| `keyword` | text | – | Keyword filter |
| `moveInDate` | text | – | Move-in date in YYYY-MM-DD format |
| `shortLet` | boolean | `false` | Short lets only |
| `photosOnly` | boolean | `false` | Photo adverts only |
| `freeToContact` | boolean | `false` | Free-to-contact adverts only |
| `noDeposit` | boolean | `false` | No/low-deposit adverts only |
| `petsAllowed` | boolean | `false` | Pets considered only |
| `parking` | boolean | `false` | Parking only |
| `disabledAccess` | boolean | `false` | Disabled access only |
| `sharedLivingRoom` | boolean | `false` | Shared living room only |
| `minBeds` | select | – | Minimum bedrooms in the property |
| `maxBeds` | select | – | Maximum bedrooms in the property |
| `roomUrls` | stringList | `[]` | SpareRoom listing URLs for `details` mode |

### What you can filter on

- Monthly rent range (`minBudget` / `maxBudget`)
- Search radius in miles (`milesFromCenter`)
- Room type: double, single, en-suite or studio/1-bed
- Property type: rooms in existing shares, studio/1-bed flats or whole properties
- Bills included, furnished/unfurnished, posted-by role
- Keyword, move-in date, short lets
- Photo adverts only, free to contact, no/low deposit
- Pets considered, parking, disabled access, shared living room
- Bedroom-count range
- Sort order: newest, recently updated, price low/high

SpareRoom shows promoted adverts at the top of some searches. The actor removes promoted rows that visibly contradict the requested budget, room type, property type, poster role, bills, photo, free-to-contact or bedroom filters, then keeps paging to fill `maxItems`.

### Output per room

Every record uses the same field names in both modes; fields the advert does not publish are omitted rather than filled with placeholders.

| Field | Meaning |
|---|---|
| `roomId` | SpareRoom advert reference number |
| `title` | Advert headline |
| `price` | Rent exactly as advertised |
| `priceType` | `pcm` (per calendar month) or `pw` (per week) |
| `priceNormalised` | SpareRoom's normalised price when the page provides one |
| `priceNormalisedType` | Period for `priceNormalised` |
| `city` | Location you searched (search mode) |
| `area` | Neighbourhood or area shown in the advert |
| `postcode` | Full or partial postcode |
| `propertyType` | Property type as shown by SpareRoom |
| `propertyTypeDetail` | Extra property-type text, for example `studio flat` |
| `roomType` | Room type shown on the card, for example `Double room` |
| `roomsInProperty` | Total bedrooms in the property |
| `housemates` | Current number of flatmates/housemates (detail pages) |
| `landlordType` | Advertiser role, for example `live in landlord`, `agent`, `current flatmate` |
| `listingType` | Advert type, usually `offered` |
| `listingStatus` | Status badges such as `new today`, `boosted`, `now let` |
| `billsIncluded` | `true` / `false` when the advert states it |
| `deposit` / `depositCurrency` | Deposit amount and currency (detail pages) |
| `availableNow` | `true` when the advert says available now |
| `availableFrom` | Availability text exactly as advertised |
| `minimumTerm` / `maximumTerm` | Minimum and maximum stay (detail pages) |
| `shortLet` | `true` when short lets are considered |
| `furnishing` | Furnished / unfurnished (detail pages) |
| `livingRoom` | Living-room arrangement (detail pages) |
| `parking`, `garage`, `garden`, `balcony`, `disabledAccess`, `wifi` | Amenity flags (detail pages) |
| `householdAges`, `householdSmoker`, `householdPets`, `householdOccupation`, `householdGender` | Current household (detail pages) |
| `couplesOk`, `smokingOk`, `petsSuitable`, `referencesRequired`, `minAge`, `maxAge` | New-flatmate preferences (detail pages) |
| `description` | Advert text (full text in details mode, snippet in search mode) |
| `imageUrl` / `imageUrls` | Main photo and full detail-page photo gallery |
| `landlordPhotoUrl` | Advertiser profile photo, when published |
| `advertiserName`, `advertiserRole`, `advertiserUpgraded`, `advertiserVerified`, `advertiserLastActive`, `advertiserResponseRate` | Advertiser information |
| `isVerified`, `isFeatured`, `isFreeToContact`, `hasVideo`, `photoCount`, `daysOld` | Listing signals from the search card |
| `roomUrl` | Canonical advert URL |
| `scrapedAt` | UTC collection timestamp |

### Examples

#### London rooms up to £1,200 within 5 miles

```json
{
  "mode": "search",
  "city": "London",
  "maxBudget": 1200,
  "milesFromCenter": 5,
  "maxItems": 100
}
```

#### Double rooms with bills included in Manchester

```json
{
  "mode": "search",
  "city": "Manchester",
  "minBudget": 500,
  "maxBudget": 900,
  "roomType": "double",
  "billsIncluded": true,
  "sortBy": "priceLow",
  "maxItems": 50
}
```

#### Fetch specific adverts

```json
{
  "mode": "details",
  "roomUrls": [
    "https://www.spareroom.co.uk/flatshare/london/chiswick/17509965",
    "https://www.spareroom.co.uk/flatshare/flatshare_detail.pl?flatshare_id=17454753"
  ]
}
```

#### Legacy task shape (still supported)

```json
{
  "mode": "searchByBudget",
  "city": "Birmingham",
  "maxBudget": 700,
  "roomType": "any",
  "milesFromCenter": 3,
  "maxItems": 20
}
```

### Pagination and source limits

Search results are read 10 adverts at a time until `maxItems` is reached or the advert list ends. SpareRoom itself caps a single search at **1,000 results** (it displays `Showing first 1000 of ... ads`). When that happens the actor tells you in the run status message. To collect more, split the search by budget band, radius, room type or property type.

### FAQ

**Do I need a SpareRoom login?** No. The actor reads the same public search and advert pages a logged-out visitor sees.

**Can I get the advertiser's email or phone number?** No. Contact details are behind SpareRoom's login and are not collected.

**Why is `priceType` sometimes `pw`?** Some advertisers quote weekly rent. The actor reports the price exactly as advertised; use `priceNormalised` when SpareRoom provides a monthly equivalent.

**Why do some records have fewer fields?** Detail-page fields such as deposit, amenities and household information only exist when the advertiser published them. Missing fields are omitted, never guessed.

**Why do search results sometimes include a promoted advert outside my radius?** SpareRoom inserts promoted adverts at the top of some result pages. The actor removes promoted rows that clearly break the selected budget, room type, property type, poster, bills, photo, free-to-contact or bedroom filters, but it cannot calculate distance from a promoted advert's postcode, so a promoted row can still sit outside the radius.

**Is this affiliated with SpareRoom?** No. This is an independent third-party actor that reads publicly visible pages from SpareRoom.co.uk.

### Data source

Public SpareRoom.co.uk pages:

- `/flatshare/<location>/` search results with SpareRoom's own filter parameters
- `/flatshare/search.pl` location resolution
- `/flatshare/<area>/<id>` and `/flatshare/flatshare_detail.pl?flatshare_id=<id>` advert pages

### Limitations

- UK only. US listings, rooms-wanted adverts and buddy-up adverts are not part of this actor.
- SpareRoom caps each search at 1,000 results; refine filters to reach more.
- Contact details, email alerts and monitoring for new listings are not included.
- A promoted advert can appear outside the chosen radius; the actor filters the other fields it can verify from the card.

# Actor input Schema

## `mode` (type: `string`):

Search current room listings, or fetch full details for a list of SpareRoom listing URLs.

## `city` (type: `string`):

UK city, town, neighbourhood or postcode (for example London, Manchester, Camden, SW2). A SpareRoom /flatshare/... URL is also accepted. Used in search mode.

## `maxItems` (type: `integer`):

Stop after this many listings. SpareRoom itself exposes at most 1,000 results per search.

## `maxBudget` (type: `integer`):

Only include rooms advertised at or below this monthly rent. Weekly adverts are matched by SpareRoom's own monthly conversion.

## `minBudget` (type: `integer`):

Only include rooms advertised at or above this monthly rent.

## `milesFromCenter` (type: `integer`):

Search radius around the chosen location. SpareRoom's own selector uses 0-5, 10, 15, 20, 30 and 40 miles.

## `roomType` (type: `string`):

Narrow results to double rooms, single rooms, en-suite rooms or studio/1-bed properties.

## `propertyType` (type: `string`):

Choose rooms in existing shared houses, studio/1-bed flats, or whole properties suitable for sharing.

## `billsIncluded` (type: `boolean`):

Only include adverts that state bills are included in the rent.

## `furnished` (type: `string`):

Filter by furnished or unfurnished adverts.

## `postedBy` (type: `string`):

Filter by who placed the advert.

## `sortBy` (type: `string`):

How SpareRoom should order results before collection.

## `keyword` (type: `string`):

Only include adverts whose text matches this keyword, for example tube, ensuite, garden.

## `moveInDate` (type: `string`):

Ask SpareRoom for rooms available on or before this date. Leave blank for any date.

## `shortLet` (type: `boolean`):

Only include adverts that consider short-term lets.

## `photosOnly` (type: `boolean`):

Only include adverts with at least one photo.

## `freeToContact` (type: `boolean`):

Only include adverts that are free to contact.

## `noDeposit` (type: `boolean`):

Only include adverts marked as no or low deposit.

## `petsAllowed` (type: `boolean`):

Only include adverts where pets are considered.

## `parking` (type: `boolean`):

Only include properties with parking available.

## `disabledAccess` (type: `boolean`):

Only include properties with disabled access.

## `sharedLivingRoom` (type: `boolean`):

Only include properties with a shared living room.

## `minBeds` (type: `string`):

Only include properties with at least this many bedrooms.

## `maxBeds` (type: `string`):

Only include properties with at most this many bedrooms (6 means 6+ on SpareRoom).

## `roomUrls` (type: `array`):

One or more public SpareRoom listing URLs for details mode. Both /flatshare/<area>/<id> and flatshare_detail.pl?flatshare_id=<id> links are accepted.

## Actor input object example

```json
{
  "mode": "search",
  "city": "London",
  "maxItems": 3,
  "maxBudget": 1500,
  "milesFromCenter": 3,
  "roomType": "any",
  "propertyType": "any",
  "billsIncluded": false,
  "furnished": "any",
  "postedBy": "any",
  "sortBy": "relevance",
  "shortLet": false,
  "photosOnly": false,
  "freeToContact": false,
  "noDeposit": false,
  "petsAllowed": false,
  "parking": false,
  "disabledAccess": false,
  "sharedLivingRoom": false,
  "roomUrls": []
}
```

# Actor output Schema

## `listings` (type: `string`):

Dataset containing all collected SpareRoom room listings.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "mode": "search",
    "city": "London",
    "maxItems": 3,
    "maxBudget": 1500,
    "milesFromCenter": 3,
    "roomType": "any",
    "propertyType": "any",
    "billsIncluded": false,
    "furnished": "any",
    "postedBy": "any",
    "sortBy": "relevance",
    "shortLet": false,
    "photosOnly": false,
    "freeToContact": false,
    "noDeposit": false,
    "petsAllowed": false,
    "parking": false,
    "disabledAccess": false,
    "sharedLivingRoom": false,
    "roomUrls": []
};

// Run the Actor and wait for it to finish
const run = await client.actor("dataspryva/spareroom-uk-flatshare-budget-and-radius-search").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "mode": "search",
    "city": "London",
    "maxItems": 3,
    "maxBudget": 1500,
    "milesFromCenter": 3,
    "roomType": "any",
    "propertyType": "any",
    "billsIncluded": False,
    "furnished": "any",
    "postedBy": "any",
    "sortBy": "relevance",
    "shortLet": False,
    "photosOnly": False,
    "freeToContact": False,
    "noDeposit": False,
    "petsAllowed": False,
    "parking": False,
    "disabledAccess": False,
    "sharedLivingRoom": False,
    "roomUrls": [],
}

# Run the Actor and wait for it to finish
run = client.actor("dataspryva/spareroom-uk-flatshare-budget-and-radius-search").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "mode": "search",
  "city": "London",
  "maxItems": 3,
  "maxBudget": 1500,
  "milesFromCenter": 3,
  "roomType": "any",
  "propertyType": "any",
  "billsIncluded": false,
  "furnished": "any",
  "postedBy": "any",
  "sortBy": "relevance",
  "shortLet": false,
  "photosOnly": false,
  "freeToContact": false,
  "noDeposit": false,
  "petsAllowed": false,
  "parking": false,
  "disabledAccess": false,
  "sharedLivingRoom": false,
  "roomUrls": []
}' |
apify call dataspryva/spareroom-uk-flatshare-budget-and-radius-search --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,dataspryva/spareroom-uk-flatshare-budget-and-radius-search"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/ojn1gPofzxbrbRaBX/builds/rbc0peMiPHCI8GRZn/openapi.json
