{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenRent Scraper - UK Rental Property Listings",
    "description": "Scrape OpenRent.co.uk rental listings for any UK city, area, or postcode. Get rent, beds, baths, photos, bills, pets, availability, and coordinates as JSON, CSV, or Excel.",
    "version": "1.0",
    "x-build-id": "fXp58u3TkIZDvdslZ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/parsebird~openrent-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-parsebird-openrent-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/parsebird~openrent-scraper/runs": {
      "post": {
        "operationId": "runs-sync-parsebird-openrent-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/parsebird~openrent-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-parsebird-openrent-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": {
          "url": {
            "title": "Search URL",
            "type": "string",
            "description": "Paste an OpenRent search-results URL (it starts with https://www.openrent.co.uk/properties-to-rent/). Filters in the URL, such as prices_min, bedrooms_max, or /houses, are applied exactly as on the website. Takes priority over Location."
          },
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Enter a UK city, town, area, or postcode, e.g. London, Manchester, SW18, or E1 6AN. Used when no Search URL is given.",
            "default": "London"
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Keep only listings whose title, description snippet, or details contain this text (case-insensitive), e.g. studio, garden, bills included. Leave empty to keep every listing."
          },
          "results_wanted": {
            "title": "Max listings",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum number of OpenRent listings to save.",
            "default": 20
          },
          "max_pages": {
            "title": "Max pages",
            "minimum": 1,
            "type": "integer",
            "description": "Safety cap on how many result pages to scan. One page is 20 listings. Raise it when a Keyword filters out most listings.",
            "default": 10
          },
          "include_photos": {
            "title": "Include photo gallery",
            "type": "boolean",
            "description": "Collect every gallery photo URL into imageUrls. Turn off to collect only the main photo and finish faster.",
            "default": true
          },
          "min_price": {
            "title": "Minimum rent (£/month)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only listings with monthly rent at or above this amount. Same as OpenRent's prices_min filter."
          },
          "max_price": {
            "title": "Maximum rent (£/month)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only listings with monthly rent at or below this amount. Same as OpenRent's prices_max filter."
          },
          "min_bedrooms": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only listings with at least this many bedrooms. As on OpenRent, studios count as 0 bedrooms and rooms in shared homes are excluded by any value of 0 or more."
          },
          "max_bedrooms": {
            "title": "Maximum bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only listings with at most this many bedrooms. Studios count as 0 bedrooms."
          },
          "property_type": {
            "title": "Property type",
            "enum": [
              "",
              "houses",
              "flats",
              "rooms"
            ],
            "type": "string",
            "description": "Limit results to houses, flats (includes studios), or rooms in shared homes.",
            "default": ""
          },
          "furnishing": {
            "title": "Furnishing",
            "enum": [
              "",
              "furnished",
              "unfurnished"
            ],
            "type": "string",
            "description": "Limit results to furnished or unfurnished listings.",
            "default": ""
          },
          "radius_km": {
            "title": "Search radius (km)",
            "minimum": 1,
            "type": "integer",
            "description": "Distance around the location to search, in kilometres. Leave empty to use OpenRent's default radius."
          },
          "sort_by": {
            "title": "Sort by",
            "enum": [
              "distance",
              "price_asc",
              "price_desc"
            ],
            "type": "string",
            "description": "Order of results. Available listings always come before let-agreed ones, as on OpenRent.",
            "default": "distance"
          },
          "bills_included": {
            "title": "Bills included",
            "type": "boolean",
            "description": "Only listings with bills included in the rent.",
            "default": false
          },
          "pets_allowed": {
            "title": "Pets allowed",
            "type": "boolean",
            "description": "Only listings that accept pets.",
            "default": false
          },
          "students_allowed": {
            "title": "Student friendly",
            "type": "boolean",
            "description": "Only listings that accept students.",
            "default": false
          },
          "families_allowed": {
            "title": "Families allowed",
            "type": "boolean",
            "description": "Only listings that accept families.",
            "default": false
          },
          "dss_accepted": {
            "title": "DSS / LHA accepted",
            "type": "boolean",
            "description": "Only listings where housing benefit (DSS/LHA) can cover the rent.",
            "default": false
          },
          "has_garden": {
            "title": "Garden",
            "type": "boolean",
            "description": "Only listings with a garden.",
            "default": false
          },
          "has_parking": {
            "title": "Parking",
            "type": "boolean",
            "description": "Only listings with parking.",
            "default": false
          },
          "exclude_let_agreed": {
            "title": "Available listings only",
            "type": "boolean",
            "description": "Skip listings already marked as let agreed.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. OpenRent works without a proxy, and if it starts blocking requests the Actor switches to Apify residential proxies (UK) automatically. Set a proxy here only to force a specific one.",
            "default": {
              "useApifyProxy": 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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}