# OnTheMarket UK Scraper API: Property Prices and Listings (`scraperseurope/onthemarket-uk`) Actor

Collect OnTheMarket UK sale listings, advertised GBP prices, qualifiers, bedrooms and source links. Paginated location search, API and JSON, CSV or Excel exports for property comparisons.

- **URL**: https://apify.com/scraperseurope/onthemarket-uk.md
- **Developed by:** [Scrapers Europe](https://apify.com/scraperseurope) (community)
- **Categories:** E-commerce
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $4.00 / 1,000 unique result delivereds

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## OnTheMarket UK Scraper API: Property Prices and Listings

Collect genuine OnTheMarket UK property sale listings with advertised GBP amounts, price qualifiers, property types, bedrooms, bathrooms and source links. Use the Apify API or export JSON, CSV and Excel for property-listing comparisons.

```json
{"term": "london", "maxItems": 3}
```

Enter a UK source location slug such as london or bath, or a public for-sale results URL. This is not arbitrary free-text property search. Unknown locations and unavailable source routes report an error, not an invented empty result. Verified source URL filters max-price and min-bedrooms are supported; customer cookies, credentials and technical settings are not accepted. Source listing pages, location, page and requested filters are checked.

`price` is the advertised GBP amount, not a valuation or a guaranteed full-ownership purchase price. Preserve `price_text`, `price_qualifier`, `listing_label` and `features_text`: guide prices, auction guides, offers and shared-ownership shares can have different conditions. An explicitly withheld POA price stays null with price_status hidden_by_source. Unknown or malformed price states are errors, not zero or fabricated prices. No finance, deposits or marketing short-price abbreviations substitute for the full advertised amount.

Display advertisements, external developer promotions and separate nearby recommendations do not count as matching properties, even when the page shows them beside zero results. No agent contacts, phone numbers, precise map coordinates, personal ownership records or private accounts are exported. Unknown fields remain empty.

The source can cap a large search at its own finite page window while reporting a much larger total. Such a verified source boundary is reported as partial/source_pagination_limit, not a full export. `searchTerms` replaces `term`; `maxItems` and deduplication are shared, while `maxPages` applies per search. Without them there are no hidden fixed item/page caps. Default runtime budget 240 seconds, adjustable to 7200, with Apify spending limits respected. Progressive delivery and automatic proxies need no customer setup. Earlier results remain if a later page fails. See `RUN_SUMMARY` and `DIAGNOSTICS`.

USD 0.004 per genuine unique delivered result plus customer-paid Apify platform consumption. No charges for duplicates, errors or summaries. Private until explicit release approval; commercial pricing is activated and verified only at publication. Independent tool, not affiliated with OnTheMarket. Respect source terms and applicable law.

# Actor input Schema

## `term` (type: `string`):

UK location slug, such as london or bath, or a supported public OnTheMarket for-sale search URL.

## `searchTerms` (type: `array`):

Replaces the single term; products are deduplicated together.

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

Global limit. Without a value, no hidden fixed result limit.

## `maxPages` (type: `integer`):

Per search. Without a value, continue to the source end or time and spending budget.

## `maxRuntimeSecs` (type: `integer`):

Earlier results remain available if a later page fails.

## `requestTimeoutSecs` (type: `integer`):

Maximum time to wait for a source request.

## Actor input object example

```json
{
  "term": "london",
  "maxRuntimeSecs": 240,
  "requestTimeoutSecs": 30
}
```

# Actor output Schema

## `products` (type: `string`):

No description

## `summary` (type: `string`):

No description

## `diagnostics` (type: `string`):

No description

# 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 = {
    "term": "london"
};

// Run the Actor and wait for it to finish
const run = await client.actor("scraperseurope/onthemarket-uk").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 = { "term": "london" }

# Run the Actor and wait for it to finish
run = client.actor("scraperseurope/onthemarket-uk").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 '{
  "term": "london"
}' |
apify call scraperseurope/onthemarket-uk --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,scraperseurope/onthemarket-uk"
        }
    }
}
```

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/tgzhkpLsSahIOIQAd/builds/9YmofY1LKHZtTwG2e/openapi.json