{
  "openapi": "3.0.1",
  "info": {
    "title": "Etsy Scraper — Search, Categories, Prices, Sales & Ads",
    "description": "Scrape Etsy search results and category pages: titles, prices, sale discounts, shops, ratings, review counts, free shipping and Etsy Ads flags. Several keywords per run, large searches split by price. From $0.0027 per listing.",
    "version": "0.1",
    "x-build-id": "gE1cyd897Le7dSXOs"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automation-lab~etsy-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automation-lab-etsy-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/automation-lab~etsy-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automation-lab-etsy-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/automation-lab~etsy-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automation-lab-etsy-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": {
          "searchQuery": {
            "title": "Search Query",
            "type": "string",
            "description": "What to search for on Etsy (e.g., 'handmade jewelry', 'vintage dress', 'custom gift'). To run several searches at once, use Search Queries."
          },
          "searchQueries": {
            "title": "Search Queries",
            "type": "array",
            "description": "Several searches in one run, each with its own Max Products. A listing found by more than one search is saved and charged once. Use this instead of, or together with, Search Query.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Etsy category URLs (https://www.etsy.com/c/jewelry/necklaces), market URLs (https://www.etsy.com/market/ceramic_mug) or search URLs. Single listing and shop URLs are not supported.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Max Products",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum products per search query or start URL. Etsy shows about 200 listings for one search view, so larger requests are read across price ranges, which reaches 1,500+ listings for a popular search. On large requests a sort holds within each price range, not across the whole run. When Etsy has fewer, the run's status message says how many you got and why.",
            "default": 64
          },
          "sort": {
            "title": "Sort Order",
            "enum": [
              "most_relevant",
              "lowest_price",
              "highest_price",
              "recently_listed"
            ],
            "type": "string",
            "description": "How to sort search results.",
            "default": "most_relevant"
          },
          "minPrice": {
            "title": "Min Price",
            "minimum": 0,
            "type": "number",
            "description": "Minimum price (in the selected currency). Listings below it are not returned."
          },
          "maxPrice": {
            "title": "Max Price",
            "minimum": 0,
            "type": "number",
            "description": "Maximum price (in the selected currency). Listings above it are not returned."
          },
          "freeShipping": {
            "title": "Free Shipping Only",
            "type": "boolean",
            "description": "Only return listings whose search card shows free shipping.",
            "default": false
          },
          "onSale": {
            "title": "On Sale Only",
            "type": "boolean",
            "description": "Only return listings that show a sale price.",
            "default": false
          },
          "currency": {
            "title": "Currency",
            "enum": [
              "USD",
              "EUR",
              "GBP",
              "CAD",
              "AUD",
              "JPY",
              "CHF",
              "SEK",
              "DKK",
              "NOK",
              "NZD",
              "SGD",
              "HKD",
              "MXN",
              "BRL",
              "INR"
            ],
            "type": "string",
            "description": "ISO 4217 currency code to use for prices (e.g. USD, EUR, GBP, CAD, AUD). Etsy converts prices to this currency, and listings it still prices in another one are skipped. With a residential proxy, the country follows this currency.",
            "default": "USD"
          },
          "locale": {
            "title": "Locale",
            "type": "string",
            "description": "BCP 47 locale code for the language of results (e.g. en-US, en-GB, de-DE, fr-FR). Affects listing titles and labels returned by Etsy.",
            "default": "en-US"
          },
          "excludeDigitalDownloads": {
            "title": "Exclude Digital Downloads",
            "type": "boolean",
            "description": "Remove listings that Etsy's search card marks as digital or instant downloads (STL files, printables, patterns, etc.). Combine with Exclude Keywords, because not every card carries the mark.",
            "default": false
          },
          "excludeKeywords": {
            "title": "Exclude Keywords",
            "type": "array",
            "description": "Skip any listing whose title contains one of these keywords (case-insensitive). Useful for removing digital or unwanted items. Example: [\"STL\", \"digital\", \"download\", \"print file\"].",
            "items": {
              "type": "string"
            }
          },
          "includeKeywords": {
            "title": "Include Keywords",
            "type": "array",
            "description": "Only keep listings whose title contains at least one of these keywords (case-insensitive). Applied after excludeKeywords. Example: [\"3D printed\", \"articulated\", \"flexi\"].",
            "items": {
              "type": "string"
            }
          },
          "enrichListingDetails": {
            "title": "Enrich Listing Details",
            "type": "boolean",
            "description": "Try each listing page for seller sales, cart and recent-purchase signals, tags, materials, shipping and personalization. Etsy blocks most listing pages, so many rows come back with null values here and the run is slower. Rows are charged the same either way.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Proxy settings. Residential proxies recommended for Etsy."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}