{
  "openapi": "3.0.1",
  "info": {
    "title": "Rightmove API · UK Property Data + Sold Prices · No-Code",
    "description": "The complete Rightmove API for UK property data. Pull live sale + rent listings, sold-price comparables (Land Registry stitched), EPC + tenure + floor area, buy-to-let filters, and polygon search — in one no-code actor.",
    "version": "1.0",
    "x-build-id": "OhBKRghraOqtQHFA7"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~rightmove-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-rightmove-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sian.agency~rightmove-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-rightmove-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sian.agency~rightmove-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-rightmove-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "searchMode": {
            "title": "🧭 Search Mode",
            "enum": [
              "bylocation",
              "byzip",
              "bycoordinates",
              "byurl",
              "bulklocations",
              "soldprices"
            ],
            "type": "string",
            "description": "How to specify what to scrape.\n\n• **bylocation** — free-text UK location (town, neighbourhood, postcode area, station)\n• **byzip** — UK postcode (outward code like NW3 or full like NW3 1AA)\n• **bycoordinates** — latitude + longitude + radius (miles)\n• **byurl** — paste a Rightmove search URL — filters are read from the URL\n• **bulklocations** — array of locations in one run (PAID)\n• **soldprices** — UK sold-price comparables (Land-Registry-style completed sales)",
            "default": "bylocation"
          },
          "listingType": {
            "title": "🏠 Listing Type",
            "enum": [
              "sale",
              "rent",
              "both"
            ],
            "type": "string",
            "description": "Which side of the UK market to scrape.\n\n• **sale** — properties for sale\n• **rent** — properties to rent\n• **both** — runs each query twice — sale + rent (PAID)\n\nIgnored when Search Mode = byurl (the URL encodes whether it's a for-sale or to-rent search) or soldprices (which is always completed sales).",
            "default": "sale"
          },
          "location": {
            "title": "📍 Location  (used when Search Mode = bylocation or soldprices)",
            "type": "string",
            "description": "Free-text UK location — neighbourhood, town, county, region, station, or postcode area.\n\nExamples: `London`, `Hampstead`, `Manchester`, `Clapham Junction`, `Edinburgh`, `SW1A`",
            "default": "London"
          },
          "locations": {
            "title": "📋 Bulk Locations  (PAID, bulklocations mode)",
            "uniqueItems": true,
            "type": "array",
            "description": "Array of UK location strings to sweep in one run. PAID tier only.",
            "items": {
              "type": "string"
            }
          },
          "zipCode": {
            "title": "📮 Postcode  (used when Search Mode = byzip)",
            "type": "string",
            "description": "UK postcode. Both forms accepted:\n\n- **Outward code** (broader): `NW3`, `SW1A`, `M1`, `EH1`, `B33`\n- **Full postcode** (tighter): `SW1A 1AA`, `NW3 1AA`\n\nOutward codes generally return broader, more useful result sets."
          },
          "latitude": {
            "title": "🗺 Latitude  (used when Search Mode = bycoordinates)",
            "type": "number",
            "description": "Latitude in decimal degrees (WGS84). London centre ≈ `51.5074`."
          },
          "longitude": {
            "title": "🗺 Longitude  (used when Search Mode = bycoordinates)",
            "type": "number",
            "description": "Longitude in decimal degrees. Negative = west of Greenwich. London centre ≈ `-0.1278`."
          },
          "rightmoveUrl": {
            "title": "🔗 Rightmove URL  (used when Search Mode = byurl)",
            "type": "string",
            "description": "Paste any search/filter URL from the Rightmove site.\n\nExamples:\n- `https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=REGION%5E87490&maxPrice=500000`\n- `https://www.rightmove.co.uk/property-to-rent/find.html?locationIdentifier=REGION%5E87540`"
          },
          "radius": {
            "title": "📏 Search radius (miles)",
            "minimum": 0,
            "maximum": 40,
            "type": "number",
            "description": "Search radius around the location/postcode/coordinates, in miles. Allowed 0–40. Default: 1 mile.",
            "default": 1
          },
          "propertyType": {
            "title": "🏘 Property type",
            "type": "string",
            "description": "Comma-separated UK property types. Leave empty to include all.\n\nAllowed: `house, detached, semi_detached, terraced, flat, bungalow, commercial, land, park_home, student_halls, other`\n\nExamples: `flat`, `house,bungalow`, `terraced,semi_detached`"
          },
          "priceRange": {
            "title": "💷 Price range (GBP)",
            "type": "string",
            "description": "Price range in GBP. Format: `min:N`, `max:N`, or `min:N,max:N`.\n\nFor sale: total price. For rent: monthly rent (pcm).\n\nExamples: `min:500000,max:1500000`, `max:2000`, `min:300000`"
          },
          "bedroomsRange": {
            "title": "🛏 Bedrooms",
            "type": "string",
            "description": "Bedroom range. Studio = `min:0`. Format: `min:N`, `max:N`, or `min:N,max:N`.\n\nExamples: `min:2`, `min:3,max:3`, `min:2,max:5`"
          },
          "bathroomsRange": {
            "title": "🛁 Bathrooms",
            "type": "string",
            "description": "Bathroom range. Format: `min:N`, `max:N`, or `min:N,max:N`."
          },
          "mustHave": {
            "title": "✅ Must-have features",
            "type": "string",
            "description": "Comma-separated features the listing MUST have.\n\nAllowed: `garden, parking, new_home, retirement, house_share, shared_ownership, auction, student`\n\nExamples: `garden`, `garden,parking`, `new_home`"
          },
          "dontShow": {
            "title": "🚫 Exclude features",
            "type": "string",
            "description": "Comma-separated features to EXCLUDE (same vocabulary as Must-have).\n\nExamples: `retirement,shared_ownership`, `auction`"
          },
          "furnishType": {
            "title": "🛋 Furnished state (rent only)",
            "type": "string",
            "description": "Furnishing filter — used when listingType = rent. Comma-separate multiple.\n\nAllowed: `furnished, part_furnished, unfurnished`"
          },
          "letType": {
            "title": "📅 Let type (rent only)",
            "enum": [
              "",
              "long_term",
              "short_term",
              "student"
            ],
            "type": "string",
            "description": "Letting term — used when listingType = rent.\n\n• **long_term** — standard assured shorthold tenancy\n• **short_term** — serviced / short lets\n• **student** — student lets",
            "default": ""
          },
          "daysSinceAdded": {
            "title": "🆕 Days since added",
            "enum": [
              "",
              "1",
              "3",
              "7",
              "14"
            ],
            "type": "string",
            "description": "Restrict to listings added in the last N days. Leave empty for any age.\n\nAllowed: `1`, `3`, `7`, `14`",
            "default": ""
          },
          "keywords": {
            "title": "🔑 Free-text keywords",
            "type": "string",
            "description": "Comma-separated free-text keywords matched against listing descriptions.\n\nExamples: `garden`, `loft conversion,balcony`, `period property`"
          },
          "sortOrder": {
            "title": "🔃 Sort order",
            "enum": [
              "",
              "highest_price",
              "lowest_price",
              "newest",
              "oldest",
              "distance"
            ],
            "type": "string",
            "description": "How results are sorted. Default: highest_price.",
            "default": ""
          },
          "resultCount": {
            "title": "📄 Records per page",
            "minimum": 1,
            "maximum": 40,
            "type": "integer",
            "description": "Records per API page (1–40). Default 25. Higher values fetch the same listings in fewer pages."
          },
          "includeUnavailable": {
            "title": "📌 Include unavailable",
            "type": "boolean",
            "description": "Also include sold-STC / let-agreed / under-offer listings alongside live ones.",
            "default": false
          },
          "soldPropertyType": {
            "title": "🏘 Sold property type (soldprices mode)",
            "enum": [
              "",
              "detached",
              "semi_detached",
              "terraced",
              "flat",
              "other"
            ],
            "type": "string",
            "description": "Filter sold prices to a single property type. Leave empty for all.\n\nAllowed: `detached, semi_detached, terraced, flat, other`",
            "default": ""
          },
          "soldTenure": {
            "title": "📜 Sold tenure",
            "enum": [
              "",
              "FREEHOLD",
              "LEASEHOLD"
            ],
            "type": "string",
            "description": "Filter by tenure.\n\n• **FREEHOLD** — own the building and the land\n• **LEASEHOLD** — own the property for a fixed term",
            "default": ""
          },
          "soldInYears": {
            "title": "⏱ Sold in last N years",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Restrict to sales completed in the last N years. Leave empty for all-time."
          },
          "soldSortBy": {
            "title": "🔃 Sold sort field",
            "enum": [
              "",
              "price",
              "address"
            ],
            "type": "string",
            "description": "Sort field for sold prices.",
            "default": ""
          },
          "soldSortOrder": {
            "title": "↕ Sold sort direction",
            "enum": [
              "",
              "DESC",
              "ASC"
            ],
            "type": "string",
            "description": "Sort direction for sold prices.",
            "default": ""
          },
          "maxResults": {
            "title": "📊 Max results per query",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Hard cap on listings returned per query. Auto-paginates until the cap is reached or the search is fully drained. Default 25. FREE tier is always capped at 25 listings per run.",
            "default": 25
          },
          "includeDetails": {
            "title": "📋 Include full property details (PAID)",
            "type": "boolean",
            "description": "When ON, fetches the full property record for each listing (1 extra API call per listing) — adds full description, EPC, tenure, floor area, key features, floorplans, virtual tours, council tax, nearest stations, and full branch contact. Adds a detail-enriched charge per successful enrichment. Disabled on FREE tier and in soldprices mode.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}