
Example Website Screenshot Crawler
No credit card required

Example Website Screenshot Crawler
No credit card required
Automated website screenshot crawler using Pyppeteer and Apify. This open-source actor captures screenshots from specified URLs, uploads them to the Apify Key-Value Store, and provides easy access to the results, making it ideal for monitoring website changes and archiving web content.
You can access the Example Website Screenshot Crawler programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
1{
2 "openapi": "3.0.1",
3 "info": {
4 "version": "1.0",
5 "x-build-id": "wEjdmWwZNYg2w3TRd"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/dz_omar~example-website-screenshot-crawler/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-dz_omar-example-website-screenshot-crawler",
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/dz_omar~example-website-screenshot-crawler/runs": {
50 "post": {
51 "operationId": "runs-sync-dz_omar-example-website-screenshot-crawler",
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/dz_omar~example-website-screenshot-crawler/run-sync": {
93 "post": {
94 "operationId": "run-sync-dz_omar-example-website-screenshot-crawler",
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 "link_urls"
135 ],
136 "properties": {
137 "fullPage": {
138 "title": "Full Page Screenshot",
139 "type": "boolean",
140 "description": "Indicates whether the screenshot should capture the entire height of the page.",
141 "default": false
142 },
143 "link_urls": {
144 "title": "Link URLs",
145 "type": "array",
146 "description": "A list of URLs to capture screenshots from.",
147 "default": [
148 "https://apify.com"
149 ],
150 "items": {
151 "type": "string"
152 }
153 },
154 "window_Width": {
155 "title": "Browser Window Width",
156 "type": "integer",
157 "description": "The width of the browser window in pixels.",
158 "default": 1920
159 },
160 "window_Height": {
161 "title": "Browser Window Height",
162 "type": "integer",
163 "description": "The height of the browser window in pixels.",
164 "default": 1080
165 },
166 "Sleep": {
167 "title": "Sleep Duration",
168 "type": "integer",
169 "description": "The duration (in seconds) to wait after loading a page before taking a screenshot.",
170 "default": 10
171 },
172 "waitUntil": {
173 "title": "Navigation Wait Condition",
174 "enum": [
175 "load",
176 "domcontentloaded",
177 "networkidle0",
178 "networkidle2"
179 ],
180 "type": "string",
181 "description": "Specify when the navigation should be considered finished. Options are 'load' for when the load event is fired, or 'domcontentloaded' for when the DOM has been loaded.",
182 "default": "networkidle0"
183 },
184 "cookies": {
185 "title": "Cookies",
186 "type": "array",
187 "description": "Cookies to be used for the browsing session, formatted as JSON objects."
188 },
189 "scrollToBottom": {
190 "title": "Enable Scrolling to Bottom",
191 "type": "boolean",
192 "description": "Determines whether the page should be scrolled to the bottom before taking a screenshot.",
193 "default": false
194 },
195 "distance": {
196 "title": "Scrolling Distance",
197 "maximum": 1000,
198 "type": "integer",
199 "description": "The distance (in pixels) to scroll down the page during each scroll action. This controls how much content is revealed with each step.",
200 "default": 100
201 },
202 "delay": {
203 "title": "Scrolling Delay",
204 "maximum": 5000,
205 "type": "integer",
206 "description": "The delay (in milliseconds) to wait after each scroll action. This can be adjusted based on how quickly content loads after scrolling.",
207 "default": 100
208 }
209 }
210 },
211 "runsResponseSchema": {
212 "type": "object",
213 "properties": {
214 "data": {
215 "type": "object",
216 "properties": {
217 "id": {
218 "type": "string"
219 },
220 "actId": {
221 "type": "string"
222 },
223 "userId": {
224 "type": "string"
225 },
226 "startedAt": {
227 "type": "string",
228 "format": "date-time",
229 "example": "2025-01-08T00:00:00.000Z"
230 },
231 "finishedAt": {
232 "type": "string",
233 "format": "date-time",
234 "example": "2025-01-08T00:00:00.000Z"
235 },
236 "status": {
237 "type": "string",
238 "example": "READY"
239 },
240 "meta": {
241 "type": "object",
242 "properties": {
243 "origin": {
244 "type": "string",
245 "example": "API"
246 },
247 "userAgent": {
248 "type": "string"
249 }
250 }
251 },
252 "stats": {
253 "type": "object",
254 "properties": {
255 "inputBodyLen": {
256 "type": "integer",
257 "example": 2000
258 },
259 "rebootCount": {
260 "type": "integer",
261 "example": 0
262 },
263 "restartCount": {
264 "type": "integer",
265 "example": 0
266 },
267 "resurrectCount": {
268 "type": "integer",
269 "example": 0
270 },
271 "computeUnits": {
272 "type": "integer",
273 "example": 0
274 }
275 }
276 },
277 "options": {
278 "type": "object",
279 "properties": {
280 "build": {
281 "type": "string",
282 "example": "latest"
283 },
284 "timeoutSecs": {
285 "type": "integer",
286 "example": 300
287 },
288 "memoryMbytes": {
289 "type": "integer",
290 "example": 1024
291 },
292 "diskMbytes": {
293 "type": "integer",
294 "example": 2048
295 }
296 }
297 },
298 "buildId": {
299 "type": "string"
300 },
301 "defaultKeyValueStoreId": {
302 "type": "string"
303 },
304 "defaultDatasetId": {
305 "type": "string"
306 },
307 "defaultRequestQueueId": {
308 "type": "string"
309 },
310 "buildNumber": {
311 "type": "string",
312 "example": "1.0.0"
313 },
314 "containerUrl": {
315 "type": "string"
316 },
317 "usage": {
318 "type": "object",
319 "properties": {
320 "ACTOR_COMPUTE_UNITS": {
321 "type": "integer",
322 "example": 0
323 },
324 "DATASET_READS": {
325 "type": "integer",
326 "example": 0
327 },
328 "DATASET_WRITES": {
329 "type": "integer",
330 "example": 0
331 },
332 "KEY_VALUE_STORE_READS": {
333 "type": "integer",
334 "example": 0
335 },
336 "KEY_VALUE_STORE_WRITES": {
337 "type": "integer",
338 "example": 1
339 },
340 "KEY_VALUE_STORE_LISTS": {
341 "type": "integer",
342 "example": 0
343 },
344 "REQUEST_QUEUE_READS": {
345 "type": "integer",
346 "example": 0
347 },
348 "REQUEST_QUEUE_WRITES": {
349 "type": "integer",
350 "example": 0
351 },
352 "DATA_TRANSFER_INTERNAL_GBYTES": {
353 "type": "integer",
354 "example": 0
355 },
356 "DATA_TRANSFER_EXTERNAL_GBYTES": {
357 "type": "integer",
358 "example": 0
359 },
360 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
361 "type": "integer",
362 "example": 0
363 },
364 "PROXY_SERPS": {
365 "type": "integer",
366 "example": 0
367 }
368 }
369 },
370 "usageTotalUsd": {
371 "type": "number",
372 "example": 0.00005
373 },
374 "usageUsd": {
375 "type": "object",
376 "properties": {
377 "ACTOR_COMPUTE_UNITS": {
378 "type": "integer",
379 "example": 0
380 },
381 "DATASET_READS": {
382 "type": "integer",
383 "example": 0
384 },
385 "DATASET_WRITES": {
386 "type": "integer",
387 "example": 0
388 },
389 "KEY_VALUE_STORE_READS": {
390 "type": "integer",
391 "example": 0
392 },
393 "KEY_VALUE_STORE_WRITES": {
394 "type": "number",
395 "example": 0.00005
396 },
397 "KEY_VALUE_STORE_LISTS": {
398 "type": "integer",
399 "example": 0
400 },
401 "REQUEST_QUEUE_READS": {
402 "type": "integer",
403 "example": 0
404 },
405 "REQUEST_QUEUE_WRITES": {
406 "type": "integer",
407 "example": 0
408 },
409 "DATA_TRANSFER_INTERNAL_GBYTES": {
410 "type": "integer",
411 "example": 0
412 },
413 "DATA_TRANSFER_EXTERNAL_GBYTES": {
414 "type": "integer",
415 "example": 0
416 },
417 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
418 "type": "integer",
419 "example": 0
420 },
421 "PROXY_SERPS": {
422 "type": "integer",
423 "example": 0
424 }
425 }
426 }
427 }
428 }
429 }
430 }
431 }
432 }
433}
Automated Website Screenshot Crawler with Pyppeteer OpenAPI definition
OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Example Website Screenshot Crawler from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients:
Actor Metrics
6 monthly users
-
1 bookmark
>99% runs succeeded
Created in Oct 2024
Modified 4 months ago