{
  "openapi": "3.0.1",
  "info": {
    "title": "Etsy Listings Scraper & Price Tracker",
    "description": "Etsy listings scraper and price tracker: scrape Etsy search results for any keyword in USD, EUR or GBP — price, sale price and discount, rating and review count, free-shipping, Star Seller and sponsored flags, image. Track price changes between runs. No personal data.",
    "version": "0.2",
    "x-build-id": "a0mxc65p9XaRaHYMO"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/myth84~etsy-search-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-myth84-etsy-search-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/myth84~etsy-search-scraper/runs": {
      "post": {
        "operationId": "runs-sync-myth84-etsy-search-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/myth84~etsy-search-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-myth84-etsy-search-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": {
          "searchQueries": {
            "title": "Search keywords",
            "type": "array",
            "description": "Enter one search per line, as you would type it in the Etsy search box, e.g. <code>ceramic mug</code> or <code>leather wallet</code>. Each search reads Etsy's market page for those words (<code>etsy.com/market/ceramic_mug</code>), up to the maximum number of listings below; a term without a market page is skipped with a message in the log. Default <code>ceramic mug</code>: it only serves runs started without any keyword or URL; with URLs alone, only the URLs are read.",
            "default": [
              "ceramic mug"
            ],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Etsy market or search URLs",
            "type": "array",
            "description": "Etsy market pages or search URLs from your browser, one per line, e.g. <code>https://www.etsy.com/market/ceramic_mug</code> or <code>https://www.etsy.com/search?q=ceramic+mug</code>. Each is read as the market page for its words, in the URL's locale, with its free-shipping parameter; <code>order=</code> is removed and <code>min=</code> / <code>max=</code> become the price range (see the README). Any other URL stops the run with a message. Default empty: keywords are enough for most searches.",
            "items": {
              "type": "string",
              "pattern": "^https?://(www\\.)?etsy\\.com/"
            },
            "default": []
          },
          "locale": {
            "title": "Locale (currency and language)",
            "enum": [
              "",
              "uk",
              "fr",
              "de",
              "es",
              "it",
              "nl",
              "ie",
              "ca",
              "au"
            ],
            "type": "string",
            "description": "Etsy site section the listings are read from: it decides the currency and the language of the results. etsy.com (USD), /uk/ (GBP) and /fr/ (EUR) were validated at build time; the other prefixes follow Etsy's URL convention and will be confirmed at the first runs. Default etsy.com (empty value, no prefix): prices in US dollars, in English.",
            "default": ""
          },
          "maxResults": {
            "title": "Maximum listings per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Stop each search after this many unique listings, from 1 to 1,000; you are never charged for more. A market page yields about 60 listings (44 organic and 16 sponsored). Default 60: about one market page per search; the form is prefilled with 20 for a quick first run.",
            "default": 60
          },
          "priceMin": {
            "title": "Min price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only listings priced at least this amount, in the currency of the locale (whole amount), e.g. <code>10</code> for 10 USD on etsy.com. The Actor applies it to the listings it fetches (Etsy's search itself is not filtered): a listing without a price is left out, maxResults counts the listings kept and Max requests bounds the pages read. Leave empty for no minimum."
          },
          "priceMax": {
            "title": "Max price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Keep only listings priced at most this amount, in the currency of the locale (whole amount), e.g. <code>50</code> for 50 USD on etsy.com; it must be at least Min price. The Actor applies it to the listings it fetches (Etsy's search itself is not filtered): a listing without a price is left out, maxResults counts the listings kept and Max requests bounds the pages read. Leave empty for no maximum."
          },
          "freeShippingOnly": {
            "title": "Free shipping only",
            "type": "boolean",
            "description": "Keep only listings with free shipping (Etsy's own filter, validated at build time). The free-shipping flag of each card is always in the <code>shippingFree</code> column. Default off: every listing, whatever its shipping cost.",
            "default": false
          },
          "includeSponsored": {
            "title": "Include sponsored listings",
            "type": "boolean",
            "description": "Etsy mixes 16 sponsored listings (\"Ad by Etsy seller\") into each page of 60. Keep them (they are flagged in the isSponsored column) or skip them. Default on: sponsored listings are real offers shown in Etsy's results.",
            "default": true
          },
          "monitorPrices": {
            "title": "Monitor prices",
            "type": "boolean",
            "description": "Off (default): every listing is returned and the four monitoring columns stay null. On: every listing is compared with the previous run of the same search, by listing id, and maxResults becomes the number of listings compared per search.",
            "default": false
          },
          "onlyChanges": {
            "title": "Return only changes",
            "type": "boolean",
            "description": "With price monitoring on: return and charge only the new listings and the listings whose price changed since the previous run; a run without any change succeeds with an empty dataset. Default off: every compared listing is returned with its changeType (new, price_changed, unchanged). Turn it on for scheduled runs.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitoring store",
            "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$",
            "type": "string",
            "description": "Name of the key-value store, in your account, that keeps the previous prices (one record per search), e.g. <code>mugs-daily</code>. Runs sharing a name share the records; use one name per schedule when two schedules run the same search with different settings. Letters, digits and dashes only, at most 63 characters; upper case is lowered. Default etsy-price-monitor: one store for all your monitoring runs.",
            "default": "etsy-price-monitor"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify residential proxies with a US exit (default, required for Etsy). The locale above decides the currency and language, not the proxy country. You can also provide your own residential proxy URLs.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "US"
            }
          },
          "maxRequests": {
            "title": "Max requests",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Safety cap on the number of requests in one run, all searches included, from 1 to 5,000: each result page costs two (the page and the call that renders its deferred listings). With a narrow price range it also bounds the pages read to find the listings in the range. Default 300: about 150 result pages, far more than a search needs (1,000 listings take about 17 pages).",
            "default": 300
          },
          "delayMs": {
            "title": "Delay between pages",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Pause between two result pages of the same search, in milliseconds, from 0 to 30,000. Increase it if you get blocked; 0 disables the pause. Default 1500 (1.5 s): the pace of the validation runs.",
            "default": 1500
          },
          "debugStoreHtml": {
            "title": "Store raw pages",
            "type": "boolean",
            "description": "Debugging only: save every fetched market page and API answer in the run's key-value store. Slows the run down and uses storage. Default off: only useful to investigate a parsing problem.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}