Magento E-Commerce Scraper 🚧
Try for free
7 days trial then $30.00/month - No credit card required now
Go to Store
Magento E-Commerce Scraper 🚧
jupri/magento-scraper
Try for free
7 days trial then $30.00/month - No credit card required now
Scrape data about product price, description and other information from Magento E-Commerce websites.
You can access the Magento E-Commerce Scraper 🚧 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": "0.1",
5 "x-build-id": "LDPpAwCn9rvaQGDla"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/jupri~magento-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-jupri-magento-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/jupri~magento-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-jupri-magento-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/jupri~magento-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-jupri-magento-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 "properties": {
134 "url": {
135 "title": "🛒 Homepage",
136 "type": "string",
137 "description": ""
138 },
139 "search": {
140 "title": "🛒 Search",
141 "type": "string",
142 "description": "Search by Keywords"
143 },
144 "limit": {
145 "title": "🛒 Limit",
146 "type": "integer",
147 "description": "Limit number of results."
148 },
149 "show_filters": {
150 "title": "Show filters",
151 "type": "boolean",
152 "description": "Show available filters & sorting Keys <i>(in console)</i>."
153 },
154 "sort": {
155 "title": "Sorting Key",
156 "type": "string",
157 "description": "Every website could have different <code>Sorting Key</code>. Use <code>show_filters=true</code> to show available options. Most common values is: <code>name, price</code>"
158 },
159 "order": {
160 "title": "Order",
161 "enum": [
162 "asc",
163 "desc"
164 ],
165 "type": "string",
166 "description": "Sorting Order"
167 },
168 "includes:description": {
169 "title": "Description",
170 "type": "boolean",
171 "description": "Long description (HTML)."
172 },
173 "includes:gallery": {
174 "title": "Media Gallery",
175 "type": "boolean",
176 "description": ""
177 },
178 "includes:related": {
179 "title": "Related Products",
180 "type": "boolean",
181 "description": ""
182 },
183 "includes:variants": {
184 "title": "Variants",
185 "type": "boolean",
186 "description": "",
187 "default": true
188 },
189 "includes:upsell": {
190 "title": "Up-Sell Products",
191 "type": "boolean",
192 "description": "<b>Upselling</b> is the process of encouraging customers to upgrade or include add-ons to the product or service they're buying."
193 },
194 "includes:crosssell": {
195 "title": "Cross-Sell Products",
196 "type": "boolean",
197 "description": "<b>Cross-selling</b> is the process of offering a customer products that are compatible with the ones they're purchasing."
198 },
199 "deprecated": {
200 "title": "Include deprecated fields",
201 "type": "boolean",
202 "description": ""
203 },
204 "filters:sku": {
205 "title": "SKU",
206 "type": "string",
207 "description": ""
208 },
209 "filters:name": {
210 "title": "Name",
211 "type": "string",
212 "description": ""
213 },
214 "filters:description": {
215 "title": "Description",
216 "type": "string",
217 "description": ""
218 },
219 "min_price": {
220 "title": "Price",
221 "type": "integer",
222 "description": "Minimum price"
223 },
224 "max_price": {
225 "title": "",
226 "type": "integer",
227 "description": "Maximum price"
228 },
229 "other_filters": {
230 "title": "More Filters",
231 "type": "array",
232 "description": "Use <i><code>show_filters=true</code></i> to show all available options.",
233 "items": {
234 "type": "object",
235 "required": [
236 "key",
237 "value"
238 ],
239 "properties": {
240 "key": {
241 "type": "string",
242 "title": "Key"
243 },
244 "value": {
245 "type": "string",
246 "title": "Value"
247 }
248 }
249 }
250 },
251 "dev_proxy_config": {
252 "title": "🌐 PROXY NETWORKING",
253 "type": "object",
254 "description": "<b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b><a href=https://scrapeops.io/app/register/main target=_blank>ScrapeOps.IO</a></b><br><code>scrapeops://{api-key}</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
255 },
256 "dev_custom_headers": {
257 "title": "📜 HTTP HEADERS",
258 "type": "array",
259 "description": "💡 Additional HTTP Headers",
260 "items": {
261 "type": "object",
262 "required": [
263 "key",
264 "value"
265 ],
266 "properties": {
267 "key": {
268 "type": "string",
269 "title": "Key"
270 },
271 "value": {
272 "type": "string",
273 "title": "Value"
274 }
275 }
276 }
277 },
278 "dev_custom_cookies": {
279 "title": "🍪 HTTP COOKIES",
280 "type": "array",
281 "description": "💡 Additional HTTP Cookies",
282 "items": {
283 "type": "object",
284 "required": [
285 "key",
286 "value"
287 ],
288 "properties": {
289 "key": {
290 "type": "string",
291 "title": "Key"
292 },
293 "value": {
294 "type": "string",
295 "title": "Value"
296 }
297 }
298 }
299 },
300 "dev_no_strip": {
301 "title": "Disable data cleansing",
302 "type": "boolean",
303 "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
304 },
305 "dev_transform_enable": {
306 "title": "Enable Custom Fields",
307 "type": "boolean",
308 "description": ""
309 },
310 "dev_transform_fields": {
311 "title": "Fields List",
312 "type": "array",
313 "description": "",
314 "items": {
315 "type": "object",
316 "required": [
317 "key",
318 "value"
319 ],
320 "properties": {
321 "key": {
322 "type": "string",
323 "title": "Key"
324 },
325 "value": {
326 "type": "string",
327 "title": "Value"
328 }
329 }
330 }
331 },
332 "dev_dataset_enable": {
333 "title": "Enable Custom Storage",
334 "type": "boolean",
335 "description": ""
336 },
337 "dev_dataset_clear": {
338 "title": "Clear Storage",
339 "type": "boolean",
340 "description": "Clear Dataset before insert/update."
341 },
342 "dev_dataset_name": {
343 "title": "Dataset Name",
344 "type": "string",
345 "description": "💡 <b>Use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
346 }
347 }
348 },
349 "runsResponseSchema": {
350 "type": "object",
351 "properties": {
352 "data": {
353 "type": "object",
354 "properties": {
355 "id": {
356 "type": "string"
357 },
358 "actId": {
359 "type": "string"
360 },
361 "userId": {
362 "type": "string"
363 },
364 "startedAt": {
365 "type": "string",
366 "format": "date-time",
367 "example": "2025-01-08T00:00:00.000Z"
368 },
369 "finishedAt": {
370 "type": "string",
371 "format": "date-time",
372 "example": "2025-01-08T00:00:00.000Z"
373 },
374 "status": {
375 "type": "string",
376 "example": "READY"
377 },
378 "meta": {
379 "type": "object",
380 "properties": {
381 "origin": {
382 "type": "string",
383 "example": "API"
384 },
385 "userAgent": {
386 "type": "string"
387 }
388 }
389 },
390 "stats": {
391 "type": "object",
392 "properties": {
393 "inputBodyLen": {
394 "type": "integer",
395 "example": 2000
396 },
397 "rebootCount": {
398 "type": "integer",
399 "example": 0
400 },
401 "restartCount": {
402 "type": "integer",
403 "example": 0
404 },
405 "resurrectCount": {
406 "type": "integer",
407 "example": 0
408 },
409 "computeUnits": {
410 "type": "integer",
411 "example": 0
412 }
413 }
414 },
415 "options": {
416 "type": "object",
417 "properties": {
418 "build": {
419 "type": "string",
420 "example": "latest"
421 },
422 "timeoutSecs": {
423 "type": "integer",
424 "example": 300
425 },
426 "memoryMbytes": {
427 "type": "integer",
428 "example": 1024
429 },
430 "diskMbytes": {
431 "type": "integer",
432 "example": 2048
433 }
434 }
435 },
436 "buildId": {
437 "type": "string"
438 },
439 "defaultKeyValueStoreId": {
440 "type": "string"
441 },
442 "defaultDatasetId": {
443 "type": "string"
444 },
445 "defaultRequestQueueId": {
446 "type": "string"
447 },
448 "buildNumber": {
449 "type": "string",
450 "example": "1.0.0"
451 },
452 "containerUrl": {
453 "type": "string"
454 },
455 "usage": {
456 "type": "object",
457 "properties": {
458 "ACTOR_COMPUTE_UNITS": {
459 "type": "integer",
460 "example": 0
461 },
462 "DATASET_READS": {
463 "type": "integer",
464 "example": 0
465 },
466 "DATASET_WRITES": {
467 "type": "integer",
468 "example": 0
469 },
470 "KEY_VALUE_STORE_READS": {
471 "type": "integer",
472 "example": 0
473 },
474 "KEY_VALUE_STORE_WRITES": {
475 "type": "integer",
476 "example": 1
477 },
478 "KEY_VALUE_STORE_LISTS": {
479 "type": "integer",
480 "example": 0
481 },
482 "REQUEST_QUEUE_READS": {
483 "type": "integer",
484 "example": 0
485 },
486 "REQUEST_QUEUE_WRITES": {
487 "type": "integer",
488 "example": 0
489 },
490 "DATA_TRANSFER_INTERNAL_GBYTES": {
491 "type": "integer",
492 "example": 0
493 },
494 "DATA_TRANSFER_EXTERNAL_GBYTES": {
495 "type": "integer",
496 "example": 0
497 },
498 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
499 "type": "integer",
500 "example": 0
501 },
502 "PROXY_SERPS": {
503 "type": "integer",
504 "example": 0
505 }
506 }
507 },
508 "usageTotalUsd": {
509 "type": "number",
510 "example": 0.00005
511 },
512 "usageUsd": {
513 "type": "object",
514 "properties": {
515 "ACTOR_COMPUTE_UNITS": {
516 "type": "integer",
517 "example": 0
518 },
519 "DATASET_READS": {
520 "type": "integer",
521 "example": 0
522 },
523 "DATASET_WRITES": {
524 "type": "integer",
525 "example": 0
526 },
527 "KEY_VALUE_STORE_READS": {
528 "type": "integer",
529 "example": 0
530 },
531 "KEY_VALUE_STORE_WRITES": {
532 "type": "number",
533 "example": 0.00005
534 },
535 "KEY_VALUE_STORE_LISTS": {
536 "type": "integer",
537 "example": 0
538 },
539 "REQUEST_QUEUE_READS": {
540 "type": "integer",
541 "example": 0
542 },
543 "REQUEST_QUEUE_WRITES": {
544 "type": "integer",
545 "example": 0
546 },
547 "DATA_TRANSFER_INTERNAL_GBYTES": {
548 "type": "integer",
549 "example": 0
550 },
551 "DATA_TRANSFER_EXTERNAL_GBYTES": {
552 "type": "integer",
553 "example": 0
554 },
555 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
556 "type": "integer",
557 "example": 0
558 },
559 "PROXY_SERPS": {
560 "type": "integer",
561 "example": 0
562 }
563 }
564 }
565 }
566 }
567 }
568 }
569 }
570 }
571}Magento E-Commerce Scraper 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 Magento E-Commerce Scraper 🚧 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:
Developer
catMaintained by Community
Actor Metrics
27 monthly users
-
4 bookmarks
61% runs succeeded
Created in May 2023
Modified a year ago
Categories
