{
  "openapi": "3.0.1",
  "info": {
    "title": "Rightmove Scraper - Real Estate Data for UK",
    "description": "Scrape real estate listings from rightmove.co.uk with filters for location, price, beds, property type, and more. Ideal for market research, lead generation, or investment analysis. Export structured property data easily in JSON or CSV format.",
    "version": "0.0",
    "x-build-id": "8fGawFaLBm2u3acB5"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/igolaizola~rightmove-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-igolaizola-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/igolaizola~rightmove-scraper/runs": {
      "post": {
        "operationId": "runs-sync-igolaizola-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/igolaizola~rightmove-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-igolaizola-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",
        "required": [
          "maxItems",
          "location"
        ],
        "properties": {
          "maxItems": {
            "title": "Max Items",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of properties to scrape",
            "default": 10
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Location to search for properties"
          },
          "operation": {
            "title": "Operation",
            "enum": [
              "buy",
              "rent"
            ],
            "type": "string",
            "description": "Operation type to search (buy, rent)",
            "default": "buy"
          },
          "sortBy": {
            "title": "Sort By",
            "enum": [
              "newestListed",
              "oldestListed",
              "lowestPrice",
              "highestPrice"
            ],
            "type": "string",
            "description": "Sort results by",
            "default": "newestListed"
          },
          "propertyTypes": {
            "title": "Property Types. Leave empty for any.",
            "type": "array",
            "description": "Property types to search. Available types: detached, semi-detached, terraced, flat, bungalow, land, park-home",
            "items": {
              "type": "string",
              "enum": [
                "detached",
                "semi-detached",
                "terraced",
                "flat",
                "bungalow",
                "land",
                "park-home",
                "private-halls"
              ],
              "enumTitles": [
                "Detached",
                "Semi-detached",
                "Terraced",
                "Flat",
                "Bungalow",
                "Land",
                "Park Home",
                "Student Halls (only for rent operation)"
              ]
            }
          },
          "minPrice": {
            "title": "Min Price",
            "type": "integer",
            "description": "Minimum price of the property (0 for any)",
            "default": 0
          },
          "maxPrice": {
            "title": "Max Price",
            "type": "integer",
            "description": "Maximum price of the property (0 for any)",
            "default": 0
          },
          "minBeds": {
            "title": "Min Beds",
            "type": "integer",
            "description": "Minimum number of bedrooms in the property (-1 for studio, 0 for any)",
            "default": 0
          },
          "maxBeds": {
            "title": "Max Beds",
            "type": "integer",
            "description": "Maximum number of bedrooms in the property (-1 for studio, 0 for any)",
            "default": 0
          },
          "minBaths": {
            "title": "Min Baths",
            "type": "integer",
            "description": "Minimum number of bathrooms in the property",
            "default": 0
          },
          "maxBaths": {
            "title": "Max Baths",
            "type": "integer",
            "description": "Maximum number of bathrooms in the property",
            "default": 0
          },
          "publicationDate": {
            "title": "Publication Date",
            "enum": [
              "",
              "24h",
              "3d",
              "7d",
              "14d"
            ],
            "type": "string",
            "description": "Publication date of the property",
            "default": ""
          },
          "includeSSTC": {
            "title": "Include Under Offer, Sold STC (only for buy operation)",
            "type": "boolean",
            "description": "Include properties marked as sold subject to contract",
            "default": false
          },
          "includeLetAgreed": {
            "title": "Include Let Agreed (only for rent operation)",
            "type": "boolean",
            "description": "Include properties marked as let agreed",
            "default": false
          },
          "mustHave": {
            "title": "Must Have",
            "type": "array",
            "description": "Features that must be present in the property",
            "items": {
              "type": "string",
              "enum": [
                "garden",
                "parking",
                "retirement",
                "newHome",
                "sharedOwnership",
                "auction",
                "houseShare",
                "student"
              ],
              "enumTitles": [
                "Garden",
                "Parking",
                "Retirement",
                "New Home (only for buy operation)",
                "Shared ownership (only for buy operation)",
                "Auction (only for buy operation)",
                "House share (only for rent operation)",
                "Student accommodation (only for rent operation)"
              ]
            }
          },
          "dontShow": {
            "title": "Don't Show",
            "type": "array",
            "description": "Features that should not be present in the property",
            "items": {
              "type": "string",
              "enum": [
                "newHome",
                "retirement",
                "sharedOwnership",
                "auction",
                "houseShare",
                "student"
              ],
              "enumTitles": [
                "New Home",
                "Retirement",
                "Shared ownership (only for buy operation)",
                "Auction (only for buy operation)",
                "House share (only for rent operation)",
                "Student accommodation (only for rent operation)"
              ]
            }
          },
          "tenureTypes": {
            "title": "Tenure Types (only for buy operation)",
            "type": "array",
            "description": "Tenure types to filter properties by. Available types: freehold, leasehold, share of freehold",
            "items": {
              "type": "string",
              "enum": [
                "freehold",
                "leasehold",
                "share_of_freehold"
              ],
              "enumTitles": [
                "Freehold",
                "Leasehold",
                "Share of Freehold"
              ]
            }
          },
          "furnishTypes": {
            "title": "Furnish Types (only for rent operation)",
            "type": "array",
            "description": "Furnishing types to filter properties by. Available types: furnished, part_furnished, unfurnished",
            "items": {
              "type": "string",
              "enum": [
                "furnished",
                "partFurnished",
                "unfurnished"
              ],
              "enumTitles": [
                "Furnished",
                "Part Furnished",
                "Unfurnished"
              ]
            }
          },
          "letType": {
            "title": "Let Type (only for rent operation)",
            "enum": [
              "",
              "longTerm",
              "shortTem"
            ],
            "type": "string",
            "description": "Let type of rental property",
            "default": ""
          },
          "moveInByDate": {
            "title": "Move-in by date (only for rent operation)",
            "pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$",
            "type": "string",
            "description": "Move-in by date for rental properties (YYYY-MM-DD)"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}