{
  "openapi": "3.0.1",
  "info": {
    "title": "Rightmove Scraper: UK Property for Sale, Rent & Sold Prices",
    "description": "Scrape Rightmove by place name, postcode or search URL: properties for sale or to rent with price, beds, agent and location, plus full details (council tax, lease, stations, EPC) and sold-price history. Filters, 1,000+ results per area and new-listing alerts.",
    "version": "1.0",
    "x-build-id": "BMrlEXNrgdUe76ztO"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sheshinmcfly~rightmove-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sheshinmcfly-rightmove-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/sheshinmcfly~rightmove-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sheshinmcfly-rightmove-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/sheshinmcfly~rightmove-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sheshinmcfly-rightmove-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": {
          "locations": {
            "title": "Locations",
            "type": "array",
            "description": "Place names (\"Manchester\", \"Clapham\"), postcodes or outcodes (\"SW1A 1AA\", \"SE15\"), or a Rightmove search URL copied from your browser (its filters are kept).",
            "items": {
              "type": "string"
            }
          },
          "listingType": {
            "title": "Search for",
            "enum": [
              "sale",
              "rent",
              "sold"
            ],
            "type": "string",
            "description": "Properties for sale, to rent, or sold house prices (sale history).",
            "default": "sale"
          },
          "maxResults": {
            "title": "Max results per location",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "How many properties to return for each location. Large areas are covered beyond the 1,000-results limit of a single Rightmove search."
          },
          "includeDetails": {
            "title": "Include full property details",
            "type": "boolean",
            "description": "Adds the full description, features, council tax band, ground rent, service charge, lease length, nearest stations, floorplans, EPC and all photos. Takes a little longer.",
            "default": false
          },
          "onlyNew": {
            "title": "Only new listings and price changes",
            "type": "boolean",
            "description": "For scheduled runs: return only properties that are new or changed price since the previous run of the same search (the first run returns everything and sets the starting point).",
            "default": false
          },
          "minPrice": {
            "title": "Min price (£)",
            "type": "integer",
            "description": "For rentals: per calendar month."
          },
          "maxPrice": {
            "title": "Max price (£)",
            "type": "integer",
            "description": "For rentals: per calendar month."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Minimum number of bedrooms."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum number of bedrooms."
          },
          "minBathrooms": {
            "title": "Min bathrooms",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Minimum number of bathrooms."
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Only these property types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "detached",
                "semi-detached",
                "terraced",
                "flat",
                "bungalow",
                "land",
                "park-home",
                "private-halls"
              ],
              "enumTitles": [
                "Detached",
                "Semi-detached",
                "Terraced",
                "Flat / apartment",
                "Bungalow",
                "Land",
                "Park home",
                "Student halls"
              ]
            }
          },
          "mustHave": {
            "title": "Must have",
            "type": "array",
            "description": "Only properties with these features.",
            "items": {
              "type": "string",
              "enum": [
                "garden",
                "parking",
                "newHome",
                "retirement",
                "sharedOwnership",
                "auction"
              ],
              "enumTitles": [
                "Garden",
                "Parking",
                "New home",
                "Retirement home",
                "Shared ownership",
                "Auction"
              ]
            }
          },
          "dontShow": {
            "title": "Don't show",
            "type": "array",
            "description": "Leave out these kinds of properties.",
            "items": {
              "type": "string",
              "enum": [
                "newHome",
                "retirement",
                "sharedOwnership",
                "auction"
              ],
              "enumTitles": [
                "New homes",
                "Retirement homes",
                "Shared ownership",
                "Auctions"
              ]
            }
          },
          "tenureTypes": {
            "title": "Tenure",
            "type": "array",
            "description": "Only these tenures.",
            "items": {
              "type": "string",
              "enum": [
                "FREEHOLD",
                "LEASEHOLD",
                "SHARE_OF_FREEHOLD"
              ],
              "enumTitles": [
                "Freehold",
                "Leasehold",
                "Share of freehold"
              ]
            }
          },
          "radius": {
            "title": "Search radius (miles)",
            "type": "number",
            "description": "Include properties within this distance of the location: 0.25, 0.5, 1, 3, 5, 10, 15, 20, 30 or 40."
          },
          "maxDaysSinceAdded": {
            "title": "Added in the last (days)",
            "type": "integer",
            "description": "1, 3, 7 or 14."
          },
          "includeSold": {
            "title": "Include sold STC / let agreed",
            "type": "boolean",
            "description": "Also include properties already under offer or let agreed.",
            "default": false
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Words that must appear in the listing, e.g. \"garage\" or \"sea view\"."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "newest",
              "oldest",
              "price-low",
              "price-high"
            ],
            "type": "string",
            "description": "Order of the results (newest listed when empty; a pasted Rightmove URL keeps its own order)."
          },
          "furnishTypes": {
            "title": "Furnishing (rentals)",
            "type": "array",
            "description": "For rentals: furnishing.",
            "items": {
              "type": "string",
              "enum": [
                "furnished",
                "partFurnished",
                "unfurnished"
              ],
              "enumTitles": [
                "Furnished",
                "Part furnished",
                "Unfurnished"
              ]
            }
          },
          "letType": {
            "title": "Let type (rentals)",
            "enum": [
              "longTerm",
              "shortTerm",
              "student"
            ],
            "type": "string",
            "description": "For rentals: type of let."
          },
          "soldWithinYears": {
            "title": "Sold in the last (years) — sold prices",
            "type": "integer",
            "description": "Only for Sold prices: 1, 2, 3, 5, 10, 15 or 20."
          },
          "locationIdentifiers": {
            "title": "Location identifiers (older setting)",
            "type": "array",
            "description": "Rightmove location codes such as REGION^87490. You can also put them in Locations.",
            "items": {
              "type": "string"
            }
          },
          "maxPages": {
            "title": "Max pages per location (older setting)",
            "type": "integer",
            "description": "Used only when Max results is not set (24 properties per page)."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "The default works; no change needed.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}