# Rightmove — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search for properties across the UK's largest property portal and retrieve detailed listings for homes for sale or to rent, including prices, descriptions, and key property information. Find your next home or investment opportunity by browsing available properties and getting comprehensive details on individual listings.

**Category:** Real Estate | **Website:** [www.rightmove.co.uk/property-for-sale/Birmingham.html](https://www.rightmove.co.uk/property-for-sale/Birmingham.html) | **Docs:** [parse.bot/marketplace/51115676-4bc9-475d-a8be-371059e1e713/rightmove-co-uk-api](https://parse.bot/marketplace/51115676-4bc9-475d-a8be-371059e1e713/rightmove-co-uk-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/rightmove/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get property details

Get detailed information for a specific property by its Rightmove ID. Returns full description, images, floorplans, key features, room dimensions, nearby stations, and agent details. Returns input_not_found if the property has been removed or sold.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Rightmove property ID (numeric string, e.g. 174878000). Obtain from search_properties results. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/rightmove/get-property-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"<string>"}'
```

### Search properties

Search for property listings on Rightmove with filters like location, price range, bedrooms, and property type. Returns paginated results with 24 properties per page. Pagination is page-based; each page returns up to 24 results. Supports BUY and RENT channels with various sort options. Accepts plain place names (e.g. 'Glasgow', 'Dennistoun') or postcodes which are automatically resolved to Rightmove location identifiers via typeahead.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `channel` | string | No | Search channel |
| `location_identifier` | string | No | Location to search. Accepts a plain place name (e.g. 'Glasgow', 'Dennistoun', 'SW1A'), a postcode, or a raw Rightmove location identifier (e.g. 'REGION^93917' for London, 'REGION^162' for Birmingham). Plain names are automatically resolved via Rightmove's typeahead. |
| `max_bedrooms` | string | No | Maximum number of bedrooms (numeric string, e.g. 4) |
| `max_pages` | integer | No | Maximum number of pages to fetch in a single request |
| `max_price` | string | No | Maximum price filter (numeric string, e.g. 500000) |
| `min_bedrooms` | string | No | Minimum number of bedrooms (numeric string, e.g. 2) |
| `min_price` | string | No | Minimum price filter (numeric string, e.g. 100000) |
| `page` | integer | No | Page number to start from (1-based) |
| `property_types` | string | No | Property type filter (e.g., detached, semi-detached, flat, terraced) |
| `radius` | string | No | Search radius in miles from location (e.g. 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30, 40) |
| `sort_type` | string | No | Sort order for results |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/rightmove/search-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"channel":"<string>","location_identifier":"<string>","max_bedrooms":"<string>","max_pages":"<integer>","max_price":"<string>","min_bedrooms":"<string>","min_price":"<string>","page":"<integer>","property_types":"<string>","radius":"<string>","sort_type":"<string>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.