{
  "openapi": "3.0.1",
  "info": {
    "title": "Rightmove UK Property Scraper (Unofficial)",
    "description": "Scrape Rightmove UK property listings, locations, filters, and property details with normalized output for price monitoring, property research, market research, and real estate workflows.",
    "version": "0.1",
    "x-build-id": "rFWvsomXtLWgi5GzT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dromb~rightmove-uk-wave1/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dromb-rightmove-uk-wave1",
        "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/dromb~rightmove-uk-wave1/runs": {
      "post": {
        "operationId": "runs-sync-dromb-rightmove-uk-wave1",
        "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/dromb~rightmove-uk-wave1/run-sync": {
      "post": {
        "operationId": "run-sync-dromb-rightmove-uk-wave1",
        "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": [
          "operation"
        ],
        "properties": {
          "operation": {
            "title": "Operation",
            "enum": [
              "probe",
              "locations",
              "search_filters",
              "search",
              "category",
              "item"
            ],
            "type": "string",
            "description": "Actor operation to execute. The Console form shows all possible fields at once, so use the README examples to see which fields are required for each operation.",
            "default": "search"
          },
          "query": {
            "title": "Query",
            "type": "string",
            "description": "Location text for search, category, locations, or search_filters when location_identifier/postcode are omitted. Example: Bristol, BS15"
          },
          "postcode": {
            "title": "Postcode",
            "type": "string",
            "description": "Postcode or outcode for search, category, locations, or search_filters. Example: BS15"
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Town, area, or station for search, category, locations, or search_filters. Example: Bristol"
          },
          "locationIdentifier": {
            "title": "Location Identifier",
            "type": "string",
            "description": "Rightmove location identifier for search, category, or search_filters. Example: REGION^219, OUTCODE^264"
          },
          "url": {
            "title": "URL",
            "type": "string",
            "description": "Full Rightmove browse URL for category or search_filters. Example: https://www.rightmove.co.uk/property-for-sale/find.html?locationIdentifier=REGION^219"
          },
          "channel": {
            "title": "Channel",
            "enum": [
              "sale",
              "rent",
              "new_homes",
              "commercial_sale",
              "commercial_rent"
            ],
            "type": "string",
            "description": "Property channel for search, category, or search_filters. Supported: sale, rent, new_homes, commercial_sale, commercial_rent",
            "default": "sale"
          },
          "toRent": {
            "title": "To Rent",
            "type": "boolean",
            "description": "Shortcut for rent channel when channel is omitted.",
            "default": false
          },
          "newHomes": {
            "title": "New Homes",
            "type": "boolean",
            "description": "Shortcut for new_homes channel when channel is omitted.",
            "default": false
          },
          "commercial": {
            "title": "Commercial",
            "type": "boolean",
            "description": "Shortcut for commercial channels when channel is omitted.",
            "default": false
          },
          "radius": {
            "title": "Radius",
            "minimum": 0,
            "maximum": 40,
            "type": "number",
            "description": "Search radius in miles for search, category, or search_filters. Range: 0-40",
            "default": 1
          },
          "priceMin": {
            "title": "Min Price",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum price in GBP for search or category."
          },
          "priceMax": {
            "title": "Max Price",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum price in GBP for search or category."
          },
          "bedroomsMin": {
            "title": "Min Bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Minimum bedrooms for search or category. Range: 0-10"
          },
          "bedroomsMax": {
            "title": "Max Bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum bedrooms for search or category. Range: 0-10"
          },
          "bathroomsMin": {
            "title": "Min Bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Minimum bathrooms for search or category. Range: 0-10"
          },
          "bathroomsMax": {
            "title": "Max Bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum bathrooms for search or category. Range: 0-10"
          },
          "propertyType": {
            "title": "Property Type",
            "type": "array",
            "description": "Repeatable property type for search or category. Example: flat, house, bungalow, detached, semi-detached, terraced, land, park-home, farm",
            "items": {
              "type": "string"
            }
          },
          "furnished": {
            "title": "Furnished",
            "type": "array",
            "description": "Repeatable furnish type for rental channels. Example: furnished, unfurnished, part_furnished",
            "items": {
              "type": "string"
            }
          },
          "mustHave": {
            "title": "Must Have",
            "type": "array",
            "description": "Repeatable must-have feature for search or category. Example: garden, parking",
            "items": {
              "type": "string"
            }
          },
          "dontShow": {
            "title": "Don't Show",
            "type": "array",
            "description": "Repeatable exclusion filter for search or category. Example: retirement",
            "items": {
              "type": "string"
            }
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "newest",
              "oldest",
              "price_asc",
              "price_desc",
              "relevance"
            ],
            "type": "string",
            "description": "Sort order for search or category. Supported: newest, oldest, price_asc, price_desc, relevance",
            "default": "newest"
          },
          "filter": {
            "title": "Filter",
            "type": "array",
            "description": "Repeatable generic filter token for search or category. Example: propertyTypes:flat, mustHave:garden",
            "items": {
              "type": "string"
            }
          },
          "page": {
            "title": "Page",
            "minimum": 1,
            "type": "integer",
            "description": "Page number for search or category. One-based.",
            "default": 1
          },
          "limit": {
            "title": "Limit",
            "minimum": 1,
            "maximum": 24,
            "type": "integer",
            "description": "Results per page for search or category. Max 24.",
            "default": 24
          },
          "propertyId": {
            "title": "Property ID",
            "type": "string",
            "description": "Rightmove property ID for item operation. Example: 171636185"
          },
          "propertyUrl": {
            "title": "Property URL",
            "type": "string",
            "description": "Full Rightmove property URL for item operation. Example: https://www.rightmove.co.uk/properties/171636185"
          },
          "includeRaw": {
            "title": "Include Raw Payload",
            "type": "boolean",
            "description": "Include the unnormalized source payload in the OUTPUT summary.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}