ETSY Crawler
Try for free
3 days trial then $35.00/month - No credit card required now
Go to Store
ETSY Crawler
jupri/etsy-scraper
Try for free
3 days trial then $35.00/month - No credit card required now
🛒 Search & Scrape ETSY.com
You can access the ETSY 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": "0.1",
5 "x-build-id": "xSVqoqh10DT63sVSW"
6 },
7 "servers": [
8 {
9 "url": "https://api.apify.com/v2"
10 }
11 ],
12 "paths": {
13 "/acts/jupri~etsy-scraper/run-sync-get-dataset-items": {
14 "post": {
15 "operationId": "run-sync-get-dataset-items-jupri-etsy-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~etsy-scraper/runs": {
50 "post": {
51 "operationId": "runs-sync-jupri-etsy-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~etsy-scraper/run-sync": {
93 "post": {
94 "operationId": "run-sync-jupri-etsy-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 "query": {
135 "title": "❓ Query",
136 "type": "string",
137 "description": "💡 Search Terms or URL"
138 },
139 "limit": {
140 "title": "♾️ Limit",
141 "type": "integer",
142 "description": "💡 Number of results"
143 },
144 "sort": {
145 "title": "Sorting",
146 "enum": [
147 "score",
148 "created",
149 "price_high",
150 "price_low"
151 ],
152 "type": "string",
153 "description": ""
154 },
155 "filters.location": {
156 "title": "🧭 Location",
157 "type": "string",
158 "description": "💡 Shop location"
159 },
160 "filters.min_price": {
161 "title": "Price Range",
162 "type": "integer",
163 "description": ""
164 },
165 "filters.max_price": {
166 "title": "",
167 "type": "integer",
168 "description": ""
169 },
170 "filters.free_shipping": {
171 "title": "FREE shipping",
172 "type": "boolean",
173 "description": ""
174 },
175 "filters.is_discounted": {
176 "title": "On sale",
177 "type": "boolean",
178 "description": ""
179 },
180 "filters.is_merch_library": {
181 "title": "ETSY's pick",
182 "type": "boolean",
183 "description": ""
184 },
185 "filters.is_star_seller": {
186 "title": "Star seller",
187 "type": "boolean",
188 "description": ""
189 },
190 "filters.max_processing_days": {
191 "title": "Ready to ship in",
192 "type": "array",
193 "description": "",
194 "items": {
195 "type": "string",
196 "enum": [
197 "1",
198 "3"
199 ],
200 "enumTitles": [
201 "1 day",
202 "1-3 days"
203 ]
204 }
205 },
206 "filters.marketplace": {
207 "title": "Item Type",
208 "enum": [
209 "homemade",
210 "vintage"
211 ],
212 "type": "string",
213 "description": ""
214 },
215 "filters.accepts_gift_cards": {
216 "title": "Accepts ETSY gift cards",
217 "type": "boolean",
218 "description": ""
219 },
220 "filters.gift_wrap": {
221 "title": "Can be gift-wrapped",
222 "type": "boolean",
223 "description": ""
224 },
225 "filters.customizable": {
226 "title": "Customizable",
227 "type": "boolean",
228 "description": ""
229 },
230 "region": {
231 "title": "Region",
232 "enum": [
233 "AF",
234 "AL",
235 "DZ",
236 "AS",
237 "AD",
238 "AO",
239 "AI",
240 "AG",
241 "AR",
242 "AM",
243 "AW",
244 "AU",
245 "AT",
246 "AZ",
247 "BS",
248 "BH",
249 "BD",
250 "BB",
251 "BE",
252 "BZ",
253 "BJ",
254 "BM",
255 "BT",
256 "BO",
257 "BA",
258 "BW",
259 "BV",
260 "BR",
261 "IO",
262 "VG",
263 "BN",
264 "BG",
265 "BF",
266 "BI",
267 "KH",
268 "CM",
269 "CA",
270 "CV",
271 "KY",
272 "CF",
273 "TD",
274 "CL",
275 "CN",
276 "CX",
277 "CC",
278 "CO",
279 "KM",
280 "CG",
281 "CK",
282 "CR",
283 "HR",
284 "CW",
285 "CY",
286 "CZ",
287 "DK",
288 "DJ",
289 "DM",
290 "DO",
291 "EC",
292 "EG",
293 "SV",
294 "GQ",
295 "ER",
296 "EE",
297 "ET",
298 "FK",
299 "FO",
300 "FJ",
301 "FI",
302 "FR",
303 "GF",
304 "PF",
305 "TF",
306 "GA",
307 "GM",
308 "GE",
309 "DE",
310 "GH",
311 "GI",
312 "GR",
313 "GL",
314 "GD",
315 "GP",
316 "GU",
317 "GT",
318 "GG",
319 "GN",
320 "GW",
321 "GY",
322 "HT",
323 "HM",
324 "VA",
325 "HN",
326 "HK",
327 "HU",
328 "IS",
329 "IN",
330 "ID",
331 "IQ",
332 "IE",
333 "IM",
334 "IL",
335 "IT",
336 "IC",
337 "JM",
338 "JP",
339 "JE",
340 "JO",
341 "KZ",
342 "KE",
343 "KI",
344 "KV",
345 "KW",
346 "KG",
347 "LA",
348 "LV",
349 "LB",
350 "LS",
351 "LR",
352 "LY",
353 "LI",
354 "LT",
355 "LU",
356 "MO",
357 "MK",
358 "MG",
359 "MW",
360 "MY",
361 "MV",
362 "ML",
363 "MT",
364 "MH",
365 "MQ",
366 "MR",
367 "MU",
368 "YT",
369 "MX",
370 "FM",
371 "MD",
372 "MC",
373 "MN",
374 "ME",
375 "MS",
376 "MA",
377 "MZ",
378 "MM",
379 "NA",
380 "NR",
381 "NP",
382 "AN",
383 "NC",
384 "NZ",
385 "NI",
386 "NE",
387 "NG",
388 "NU",
389 "NF",
390 "MP",
391 "NO",
392 "OM",
393 "PK",
394 "PW",
395 "PS",
396 "PA",
397 "PG",
398 "PY",
399 "PE",
400 "PH",
401 "PL",
402 "PT",
403 "PR",
404 "QA",
405 "RE",
406 "RO",
407 "RW",
408 "SH",
409 "KN",
410 "LC",
411 "MF",
412 "PM",
413 "VC",
414 "WS",
415 "SM",
416 "ST",
417 "SA",
418 "SN",
419 "RS",
420 "SC",
421 "SL",
422 "SG",
423 "SX",
424 "SK",
425 "SI",
426 "SB",
427 "SO",
428 "ZA",
429 "GS",
430 "KR",
431 "SS",
432 "ES",
433 "LK",
434 "SD",
435 "SR",
436 "SJ",
437 "SZ",
438 "SE",
439 "CH",
440 "TW",
441 "TJ",
442 "TZ",
443 "TH",
444 "NL",
445 "TL",
446 "TG",
447 "TK",
448 "TO",
449 "TT",
450 "TN",
451 "TR",
452 "TM",
453 "TC",
454 "TV",
455 "VI",
456 "UG",
457 "UA",
458 "AE",
459 "GB",
460 "US",
461 "UM",
462 "UY",
463 "UZ",
464 "VU",
465 "VE",
466 "VN",
467 "WF",
468 "EH",
469 "YE",
470 "CD",
471 "ZM",
472 "ZW",
473 "AX"
474 ],
475 "type": "string",
476 "description": "💡 Delivery location",
477 "default": "US"
478 },
479 "language": {
480 "title": "Language",
481 "enum": [
482 "de",
483 "en-IN",
484 "en-GB",
485 "en-US",
486 "es",
487 "fr",
488 "it",
489 "nl",
490 "pl",
491 "pt",
492 "ru",
493 "ja"
494 ],
495 "type": "string",
496 "description": "",
497 "default": "en-US"
498 },
499 "currency": {
500 "title": "Currency",
501 "enum": [
502 "AUD",
503 "CAD",
504 "HKD",
505 "MXN",
506 "NZD",
507 "SGD",
508 "USD",
509 "MAD",
510 "HUF",
511 "CZK",
512 "TWD",
513 "ZAR",
514 "BRL",
515 "MYR",
516 "IDR",
517 "CHF",
518 "DKK",
519 "NOK",
520 "SEK",
521 "PLN",
522 "GBP",
523 "CNY",
524 "JPY",
525 "THB",
526 "ILS",
527 "VND",
528 "EUR",
529 "PHP",
530 "INR",
531 "TRY"
532 ],
533 "type": "string",
534 "description": "",
535 "default": "USD"
536 },
537 "dev_proxy_config": {
538 "title": "🌐 PROXY NETWORKING",
539 "type": "object",
540 "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>Example</b>: <code>socks5://example.com:9000</code>"
541 },
542 "dev_custom_headers": {
543 "title": "📜 HTTP HEADERS",
544 "type": "array",
545 "description": "💡 Additional HTTP Headers",
546 "items": {
547 "type": "object",
548 "required": [
549 "key",
550 "value"
551 ],
552 "properties": {
553 "key": {
554 "type": "string",
555 "title": "Key"
556 },
557 "value": {
558 "type": "string",
559 "title": "Value"
560 }
561 }
562 }
563 },
564 "dev_custom_cookies": {
565 "title": "🍰 HTTP COOKIES",
566 "type": "array",
567 "description": "💡 Additional HTTP Cookies",
568 "items": {
569 "type": "object",
570 "required": [
571 "key",
572 "value"
573 ],
574 "properties": {
575 "key": {
576 "type": "string",
577 "title": "Key"
578 },
579 "value": {
580 "type": "string",
581 "title": "Value"
582 }
583 }
584 }
585 },
586 "dev_transform_fields": {
587 "title": "♻️ CUSTOM FIELD",
588 "type": "array",
589 "description": "💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>",
590 "items": {
591 "type": "object",
592 "required": [
593 "key",
594 "value"
595 ],
596 "properties": {
597 "key": {
598 "type": "string",
599 "title": "Key"
600 },
601 "value": {
602 "type": "string",
603 "title": "Value"
604 }
605 }
606 }
607 },
608 "dev_dataset_name": {
609 "title": "📁 CUSTOM STORAGE",
610 "type": "string",
611 "description": "💡 <b>Save results into custom named Dataset, 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>"
612 },
613 "dev_dataset_clear": {
614 "title": "Clear Storage",
615 "type": "boolean",
616 "description": "Clear Dataset before insert/update."
617 },
618 "dev_no_strip": {
619 "title": "Disable data cleansing",
620 "type": "boolean",
621 "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
622 }
623 }
624 },
625 "runsResponseSchema": {
626 "type": "object",
627 "properties": {
628 "data": {
629 "type": "object",
630 "properties": {
631 "id": {
632 "type": "string"
633 },
634 "actId": {
635 "type": "string"
636 },
637 "userId": {
638 "type": "string"
639 },
640 "startedAt": {
641 "type": "string",
642 "format": "date-time",
643 "example": "2025-01-08T00:00:00.000Z"
644 },
645 "finishedAt": {
646 "type": "string",
647 "format": "date-time",
648 "example": "2025-01-08T00:00:00.000Z"
649 },
650 "status": {
651 "type": "string",
652 "example": "READY"
653 },
654 "meta": {
655 "type": "object",
656 "properties": {
657 "origin": {
658 "type": "string",
659 "example": "API"
660 },
661 "userAgent": {
662 "type": "string"
663 }
664 }
665 },
666 "stats": {
667 "type": "object",
668 "properties": {
669 "inputBodyLen": {
670 "type": "integer",
671 "example": 2000
672 },
673 "rebootCount": {
674 "type": "integer",
675 "example": 0
676 },
677 "restartCount": {
678 "type": "integer",
679 "example": 0
680 },
681 "resurrectCount": {
682 "type": "integer",
683 "example": 0
684 },
685 "computeUnits": {
686 "type": "integer",
687 "example": 0
688 }
689 }
690 },
691 "options": {
692 "type": "object",
693 "properties": {
694 "build": {
695 "type": "string",
696 "example": "latest"
697 },
698 "timeoutSecs": {
699 "type": "integer",
700 "example": 300
701 },
702 "memoryMbytes": {
703 "type": "integer",
704 "example": 1024
705 },
706 "diskMbytes": {
707 "type": "integer",
708 "example": 2048
709 }
710 }
711 },
712 "buildId": {
713 "type": "string"
714 },
715 "defaultKeyValueStoreId": {
716 "type": "string"
717 },
718 "defaultDatasetId": {
719 "type": "string"
720 },
721 "defaultRequestQueueId": {
722 "type": "string"
723 },
724 "buildNumber": {
725 "type": "string",
726 "example": "1.0.0"
727 },
728 "containerUrl": {
729 "type": "string"
730 },
731 "usage": {
732 "type": "object",
733 "properties": {
734 "ACTOR_COMPUTE_UNITS": {
735 "type": "integer",
736 "example": 0
737 },
738 "DATASET_READS": {
739 "type": "integer",
740 "example": 0
741 },
742 "DATASET_WRITES": {
743 "type": "integer",
744 "example": 0
745 },
746 "KEY_VALUE_STORE_READS": {
747 "type": "integer",
748 "example": 0
749 },
750 "KEY_VALUE_STORE_WRITES": {
751 "type": "integer",
752 "example": 1
753 },
754 "KEY_VALUE_STORE_LISTS": {
755 "type": "integer",
756 "example": 0
757 },
758 "REQUEST_QUEUE_READS": {
759 "type": "integer",
760 "example": 0
761 },
762 "REQUEST_QUEUE_WRITES": {
763 "type": "integer",
764 "example": 0
765 },
766 "DATA_TRANSFER_INTERNAL_GBYTES": {
767 "type": "integer",
768 "example": 0
769 },
770 "DATA_TRANSFER_EXTERNAL_GBYTES": {
771 "type": "integer",
772 "example": 0
773 },
774 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
775 "type": "integer",
776 "example": 0
777 },
778 "PROXY_SERPS": {
779 "type": "integer",
780 "example": 0
781 }
782 }
783 },
784 "usageTotalUsd": {
785 "type": "number",
786 "example": 0.00005
787 },
788 "usageUsd": {
789 "type": "object",
790 "properties": {
791 "ACTOR_COMPUTE_UNITS": {
792 "type": "integer",
793 "example": 0
794 },
795 "DATASET_READS": {
796 "type": "integer",
797 "example": 0
798 },
799 "DATASET_WRITES": {
800 "type": "integer",
801 "example": 0
802 },
803 "KEY_VALUE_STORE_READS": {
804 "type": "integer",
805 "example": 0
806 },
807 "KEY_VALUE_STORE_WRITES": {
808 "type": "number",
809 "example": 0.00005
810 },
811 "KEY_VALUE_STORE_LISTS": {
812 "type": "integer",
813 "example": 0
814 },
815 "REQUEST_QUEUE_READS": {
816 "type": "integer",
817 "example": 0
818 },
819 "REQUEST_QUEUE_WRITES": {
820 "type": "integer",
821 "example": 0
822 },
823 "DATA_TRANSFER_INTERNAL_GBYTES": {
824 "type": "integer",
825 "example": 0
826 },
827 "DATA_TRANSFER_EXTERNAL_GBYTES": {
828 "type": "integer",
829 "example": 0
830 },
831 "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
832 "type": "integer",
833 "example": 0
834 },
835 "PROXY_SERPS": {
836 "type": "integer",
837 "example": 0
838 }
839 }
840 }
841 }
842 }
843 }
844 }
845 }
846 }
847}ETSY 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 ETSY 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:
Developer
catMaintained by Community
Actor Metrics
5 monthly users
-
5 bookmarks
>99% runs succeeded
Created in Jun 2024
Modified 5 months ago
Categories
