Rightmove Commercial Scraper

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "0.0",
5    "x-build-id": "hYZmQBPACU8LvweIR"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/dhrumil~rightmove-commercial-scraper/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-dhrumil-rightmove-commercial-scraper",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/dhrumil~rightmove-commercial-scraper/runs": {
50      "post": {
51        "operationId": "runs-sync-dhrumil-rightmove-commercial-scraper",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/dhrumil~rightmove-commercial-scraper/run-sync": {
93      "post": {
94        "operationId": "run-sync-dhrumil-rightmove-commercial-scraper",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "listUrls"
135        ],
136        "properties": {
137          "listUrls": {
138            "title": "List URLs",
139            "type": "array",
140            "description": "Any rightmove-commercial sale or rent property listing url which has list of properties",
141            "default": [
142              {
143                "url": "https://www.rightmove.co.uk/commercial-property-for-sale/find.html?locationIdentifier=OUTCODE%5E1855"
144              }
145            ],
146            "items": {
147              "type": "object",
148              "required": [
149                "url"
150              ],
151              "properties": {
152                "url": {
153                  "type": "string",
154                  "title": "URL of a web page",
155                  "format": "uri"
156                }
157              }
158            }
159          },
160          "fullScrape": {
161            "title": "Scrape all the properties from all pages available in given listing urls",
162            "type": "boolean",
163            "description": "If checked, it will perform full scrape including all pagination pages. You might want to turn this off in case you are running in monitoring mode.",
164            "default": true
165          },
166          "monitoringMode": {
167            "title": "Run in monitoring mode where only newly listed properties compared to previous runs will be scraped",
168            "type": "boolean",
169            "description": "If checked, it will only scrape newly listed properties compared to what has been scraped in previous runs. Please turn off full scrape setting above in case you are tunring this on.",
170            "default": false
171          },
172          "enableDelistingTracker": {
173            "title": "Enable Delisting tracker with KV Store",
174            "type": "boolean",
175            "description": "If checked, it will track every single property with date so that you can find out which property is delisted. ( Enabling this has impact on billing )",
176            "default": false
177          },
178          "addEmptyTrackerRecord": {
179            "title": "Add tracker ID record in incremental mode",
180            "type": "boolean",
181            "description": "If checked, it will add tracker ID record in incremental mode so that you can identify delisted properties if you have custom loader",
182            "default": false
183          },
184          "proxy": {
185            "title": "Proxy configuration",
186            "type": "object",
187            "description": "Select proxies to be used by your crawler.",
188            "default": {
189              "useApifyProxy": true
190            }
191          }
192        }
193      },
194      "runsResponseSchema": {
195        "type": "object",
196        "properties": {
197          "data": {
198            "type": "object",
199            "properties": {
200              "id": {
201                "type": "string"
202              },
203              "actId": {
204                "type": "string"
205              },
206              "userId": {
207                "type": "string"
208              },
209              "startedAt": {
210                "type": "string",
211                "format": "date-time",
212                "example": "2025-01-08T00:00:00.000Z"
213              },
214              "finishedAt": {
215                "type": "string",
216                "format": "date-time",
217                "example": "2025-01-08T00:00:00.000Z"
218              },
219              "status": {
220                "type": "string",
221                "example": "READY"
222              },
223              "meta": {
224                "type": "object",
225                "properties": {
226                  "origin": {
227                    "type": "string",
228                    "example": "API"
229                  },
230                  "userAgent": {
231                    "type": "string"
232                  }
233                }
234              },
235              "stats": {
236                "type": "object",
237                "properties": {
238                  "inputBodyLen": {
239                    "type": "integer",
240                    "example": 2000
241                  },
242                  "rebootCount": {
243                    "type": "integer",
244                    "example": 0
245                  },
246                  "restartCount": {
247                    "type": "integer",
248                    "example": 0
249                  },
250                  "resurrectCount": {
251                    "type": "integer",
252                    "example": 0
253                  },
254                  "computeUnits": {
255                    "type": "integer",
256                    "example": 0
257                  }
258                }
259              },
260              "options": {
261                "type": "object",
262                "properties": {
263                  "build": {
264                    "type": "string",
265                    "example": "latest"
266                  },
267                  "timeoutSecs": {
268                    "type": "integer",
269                    "example": 300
270                  },
271                  "memoryMbytes": {
272                    "type": "integer",
273                    "example": 1024
274                  },
275                  "diskMbytes": {
276                    "type": "integer",
277                    "example": 2048
278                  }
279                }
280              },
281              "buildId": {
282                "type": "string"
283              },
284              "defaultKeyValueStoreId": {
285                "type": "string"
286              },
287              "defaultDatasetId": {
288                "type": "string"
289              },
290              "defaultRequestQueueId": {
291                "type": "string"
292              },
293              "buildNumber": {
294                "type": "string",
295                "example": "1.0.0"
296              },
297              "containerUrl": {
298                "type": "string"
299              },
300              "usage": {
301                "type": "object",
302                "properties": {
303                  "ACTOR_COMPUTE_UNITS": {
304                    "type": "integer",
305                    "example": 0
306                  },
307                  "DATASET_READS": {
308                    "type": "integer",
309                    "example": 0
310                  },
311                  "DATASET_WRITES": {
312                    "type": "integer",
313                    "example": 0
314                  },
315                  "KEY_VALUE_STORE_READS": {
316                    "type": "integer",
317                    "example": 0
318                  },
319                  "KEY_VALUE_STORE_WRITES": {
320                    "type": "integer",
321                    "example": 1
322                  },
323                  "KEY_VALUE_STORE_LISTS": {
324                    "type": "integer",
325                    "example": 0
326                  },
327                  "REQUEST_QUEUE_READS": {
328                    "type": "integer",
329                    "example": 0
330                  },
331                  "REQUEST_QUEUE_WRITES": {
332                    "type": "integer",
333                    "example": 0
334                  },
335                  "DATA_TRANSFER_INTERNAL_GBYTES": {
336                    "type": "integer",
337                    "example": 0
338                  },
339                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
340                    "type": "integer",
341                    "example": 0
342                  },
343                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
344                    "type": "integer",
345                    "example": 0
346                  },
347                  "PROXY_SERPS": {
348                    "type": "integer",
349                    "example": 0
350                  }
351                }
352              },
353              "usageTotalUsd": {
354                "type": "number",
355                "example": 0.00005
356              },
357              "usageUsd": {
358                "type": "object",
359                "properties": {
360                  "ACTOR_COMPUTE_UNITS": {
361                    "type": "integer",
362                    "example": 0
363                  },
364                  "DATASET_READS": {
365                    "type": "integer",
366                    "example": 0
367                  },
368                  "DATASET_WRITES": {
369                    "type": "integer",
370                    "example": 0
371                  },
372                  "KEY_VALUE_STORE_READS": {
373                    "type": "integer",
374                    "example": 0
375                  },
376                  "KEY_VALUE_STORE_WRITES": {
377                    "type": "number",
378                    "example": 0.00005
379                  },
380                  "KEY_VALUE_STORE_LISTS": {
381                    "type": "integer",
382                    "example": 0
383                  },
384                  "REQUEST_QUEUE_READS": {
385                    "type": "integer",
386                    "example": 0
387                  },
388                  "REQUEST_QUEUE_WRITES": {
389                    "type": "integer",
390                    "example": 0
391                  },
392                  "DATA_TRANSFER_INTERNAL_GBYTES": {
393                    "type": "integer",
394                    "example": 0
395                  },
396                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
397                    "type": "integer",
398                    "example": 0
399                  },
400                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
401                    "type": "integer",
402                    "example": 0
403                  },
404                  "PROXY_SERPS": {
405                    "type": "integer",
406                    "example": 0
407                  }
408                }
409              }
410            }
411          }
412        }
413      }
414    }
415  }
416}