{ "openapi": "3.0.1", "info": { "title": "E-commerce Scraping Tool", "description": "Scrape data from e-commerce websites with E-commerce Scraping Tool. Scrape almost any retail site in minutes, extract e-commerce data and use it to monitor price details over time or compare different e-commerce sites’ offerings.", "version": "0.0", "x-build-id": "4Dvt4cnm3OzG8LYr3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apify~e-commerce-scraping-tool/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apify-e-commerce-scraping-tool", "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/apify~e-commerce-scraping-tool/runs": { "post": { "operationId": "runs-sync-apify-e-commerce-scraping-tool", "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/apify~e-commerce-scraping-tool/run-sync": { "post": { "operationId": "run-sync-apify-e-commerce-scraping-tool", "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": { "scrapeMode": { "title": "Scrape mode", "enum": [ "AUTO", "BROWSER", "HTTP" ], "type": "string", "description": "Select how the data should be scraped: 'Browser' for full browser rendering, 'HTTP' for lightweight requests, or 'Auto' to let the system decide automatically.", "default": "AUTO" }, "detailsUrls": { "title": "Product detail URLs", "type": "array", "description": "Direct URLs to individual product detail pages.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingUrls": { "title": "Category listing URLs", "type": "array", "description": "URLs to category or listing pages that contain multiple products.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keyword": { "title": "Keyword for search", "type": "string", "description": "A keyword used to search for products across marketplaces." }, "marketplaces": { "title": "Marketplaces for keyword search", "type": "array", "description": "Select the marketplaces where the keyword search should be performed.", "items": { "type": "string", "enum": [ "www.academy.com", "www.ae.com", "www.albertsons.com", "www.aldi.co.uk", "www.alibaba.com", "allegro.pl", "allegro.sk", "allegro.cz", "www.alza.cz", "www.alza.sk", "www.alza.hu", "www.alza.at", "www.alza.de", "www.amazon.ae", "www.amazon.ca", "www.amazon.cn", "www.amazon.co.jp", "www.amazon.co.uk", "www.amazon.com", "www.amazon.com.au", "www.amazon.com.be", "www.amazon.com.br", "www.amazon.com.mx", "www.amazon.com.sg", "www.amazon.com.tr", "www.amazon.de", "www.amazon.eg", "www.amazon.es", "www.amazon.fr", "www.amazon.ie", "www.amazon.in", "www.amazon.it", "www.amazon.nl", "www.amazon.pl", "www.amazon.sa", "www.amazon.se", "www.anthropologie.com", "www.ao.com", "www.argos.co.uk", "www.ariat.com", "www.asda.com", "www.ashleyfurniture.com", "www.autozone.com", "www.barnesandnoble.com", "www.basspro.com", "www.bestbuy.com", "www.bestbuy.ca", "www.bjs.com", "www.bloomingdales.com", "www.bluemercury.com", "www.bol.com", "www.boots.com", "www.cdiscount.com", "www.chewy.com", "www.coles.com.au", "www.coop.co.uk", "www.costco.com", "www.costco.ca", "www.cvs.com", "www.dickssportinggoods.com", "www.ebay.com", "www.ebay.co.uk", "www.ebay.de", "www.ebay.fr", "www.ebay.it", "www.ebay.es", "www.ebay.com.au", "www.ebay.ca", "www.galaxus.ch", "www.goofish.com", "www.grainger.ca", "www.grainger.com", "www.harborfreight.com", "www.hepsiburada.com", "www.homedepot.com", "www.iceland.co.uk", "www.idealo.at", "www.idealo.co.uk", "www.idealo.de", "www.idealo.es", "www.idealo.fr", "www.idealo.it", "www.ikea.com", "www.ikea.com/ae/ar", "www.ikea.com/ae/en", "www.ikea.com/at/de", "www.ikea.com/at/en", "www.ikea.com/au/en", "www.ikea.com/be/en", "www.ikea.com/be/fr", "www.ikea.com/be/nl", "www.ikea.com/bh/ar", "www.ikea.com/bh/en", "www.ikea.com/ca/en", "www.ikea.com/ca/fr", "www.ikea.com/ch/de", "www.ikea.com/ch/en", "www.ikea.com/ch/fr", "www.ikea.com/ch/it", "www.ikea.com/cl/es", "www.ikea.com/co/es", "www.ikea.com/cz/cs", "www.ikea.com/cz/en", "www.ikea.com/de/de", "www.ikea.com/de/en", "www.ikea.com/dk/da", "www.ikea.com/eg/ar", "www.ikea.com/eg/en", "www.ikea.com/fi/en", "www.ikea.com/fi/fi", "www.ikea.com/fr/fr", "www.ikea.com/gb/en", "www.ikea.com/hr/hr", "www.ikea.com/hu/hu", "www.ikea.com/ie/en", "www.ikea.com/il/he", "www.ikea.com/in/en", "www.ikea.com/it/it", "www.ikea.com/jo/ar", "www.ikea.com/jo/en", "www.ikea.com/jp/en", "www.ikea.com/jp/ja", "www.ikea.com/kr/en", "www.ikea.com/kr/ko", "www.ikea.com/kw/ar", "www.ikea.com/kw/en", "www.ikea.com/ma/ar", "www.ikea.com/ma/en", "www.ikea.com/ma/fr", "www.ikea.com/mx/en", "www.ikea.com/mx/es", "www.ikea.com/my/en", "www.ikea.com/my/ms", "www.ikea.com/nl/en", "www.ikea.com/nl/nl", "www.ikea.com/no/en", "www.ikea.com/no/no", "www.ikea.com/nz/en", "www.ikea.com/om/ar", "www.ikea.com/om/en", "www.ikea.com/ph/en", "www.ikea.com/pl/pl", "www.ikea.com/pt/en", "www.ikea.com/pt/pt", "www.ikea.com/qa/ar", "www.ikea.com/qa/en", "www.ikea.com/ro/ro", "www.ikea.com/rs/sr", "www.ikea.com/sa/ar", "www.ikea.com/sa/en", "www.ikea.com/se/en", "www.ikea.com/se/sv", "www.ikea.com/sg/en", "www.ikea.com/si/sl", "www.ikea.com/sk/sk", "www.ikea.com/th/en", "www.ikea.com/th/th", "www.ikea.com/ua/uk", "www.ikea.com/us/en", "www.ikea.com/us/es", "www.insulationpoint.co.uk", "www.johnlewis.com", "www.kaufland.de", "www.kaufland.cz", "www.kaufland.sk", "www.kaufland.pl", "www.kaufland.at", "www.kaufland.it", "www.kaufland.fr", "www.kohls.com", "www.lidl.co.uk", "www.lowes.com", "www.macys.com", "www.marksandspencer.com", "www.mediamarkt.de", "www.meijer.com", "www.menswearhouse.com", "www.mercadolibre.com.ar", "listado.mercadolibre.com.ar", "articulo.mercadolibre.com.ar", "www.mercadolibre.com.bo", "listado.mercadolibre.com.bo", "articulo.mercadolibre.com.bo", "servicio.mercadolibre.com.bo", "www.mercadolivre.com.br", "lista.mercadolivre.com.br", "produto.mercadolivre.com.br", "www.mercadolibre.cl", "listado.mercadolibre.cl", "articulo.mercadolibre.cl", "www.mercadolibre.com.co", "listado.mercadolibre.com.co", "articulo.mercadolibre.com.co", "www.mercadolibre.co.cr", "listado.mercadolibre.co.cr", "articulo.mercadolibre.co.cr", "www.mercadolibre.com.do", "listado.mercadolibre.com.do", "articulo.mercadolibre.com.do", "www.mercadolibre.com.ec", "listado.mercadolibre.com.ec", "articulo.mercadolibre.com.ec", "www.mercadolibre.com.gt", "listado.mercadolibre.com.gt", "articulo.mercadolibre.com.gt", "www.mercadolibre.com.hn", "listado.mercadolibre.com.hn", "articulo.mercadolibre.com.hn", "www.mercadolibre.com.mx", "listado.mercadolibre.com.mx", "articulo.mercadolibre.com.mx", "www.mercadolibre.com.ni", "listado.mercadolibre.com.ni", "articulo.mercadolibre.com.ni", "www.mercadolibre.com.pa", "listado.mercadolibre.com.pa", "articulo.mercadolibre.com.pa", "www.mercadolibre.com.py", "listado.mercadolibre.com.py", "articulo.mercadolibre.com.py", "servicio.mercadolibre.com.py", "www.mercadolibre.com.pe", "listado.mercadolibre.com.pe", "articulo.mercadolibre.com.pe", "www.mercadolibre.com.sv", "listado.mercadolibre.com.sv", "articulo.mercadolibre.com.sv", "www.mercadolibre.com.uy", "listado.mercadolibre.com.uy", "articulo.mercadolibre.com.uy", "www.mercadolibre.com.ve", "listado.mercadolibre.com.ve", "articulo.mercadolibre.com.ve", "groceries.morrisons.com", "www.mscdirect.com", "www.newegg.com", "www.next.co.uk", "www.noon.com", "www.nordstrom.com", "www.ocado.com", "www.petco.com", "www.sainsburys.co.uk", "www.saloncentric.com", "www.sephora.com", "www.smythstoys.com", "www.spacenk.com", "www.staples.ca", "www.staples.com", "www.superdrug.com", "www.takealot.com", "www.target.com", "www.tesco.com", "www.trendyol.com", "www.uline.ca", "www.uline.com", "www.ulta.com", "www.waitrose.com", "www.walgreens.com", "www.walmart.com", "www.walmart.ca", "www.wayfair.com" ], "enumTitles": [ "Academy Sports + Outdoors", "American Eagle", "Albertsons", "Aldi (United Kingdom)", "Alibaba", "Allegro (Poland)", "Allegro (Slovakia)", "Allegro (Czech Republic)", "Alza (Czech Republic)", "Alza (Slovakia)", "Alza (Hungary)", "Alza (Austria)", "Alza (Germany)", "Amazon (United Arab Emirates)", "Amazon (Canada)", "Amazon (China)", "Amazon (Japan)", "Amazon (United Kingdom)", "Amazon (United States)", "Amazon (Australia)", "Amazon (Belgium)", "Amazon (Brazil)", "Amazon (Mexico)", "Amazon (Singapore)", "Amazon (Turkey)", "Amazon (Germany)", "Amazon (Egypt)", "Amazon (Spain)", "Amazon (France)", "Amazon (Ireland)", "Amazon (India)", "Amazon (Italy)", "Amazon (Netherlands)", "Amazon (Poland)", "Amazon (Saudi Arabia)", "Amazon (Sweden)", "Anthropologie", "AO", "Argos", "Ariat", "Asda", "Ashleyfurniture", "AutoZone", "Barnes & Noble", "Bass Pro Shops", "BestBuy (United States)", "BestBuy (Canada)", "BJ's Wholesale Club", "Bloomingdale's", "Bluemercury", "Bol", "Boots", "Cdiscount", "Chewy", "Coles", "Co-op (United Kingdom)", "Costco (United States)", "Costco (Canada)", "CVS", "Dick's Sporting Goods", "eBay.com", "eBay (UK)", "eBay (Germany)", "eBay (France)", "eBay (Italy)", "eBay (Spain)", "eBay (Australia)", "eBay (Canada)", "Galaxus", "Goofish", "Grainger (Canada)", "Grainger (United States)", "Harbor Freight", "Hepsiburada", "Home Depot", "Iceland", "Idealo (Austria)", "Idealo (United Kingdom)", "Idealo (Germany)", "Idealo (Spain)", "Idealo (France)", "Idealo (Italy)", "IKEA", "IKEA (United Arab Emirates – Arabic)", "IKEA (United Arab Emirates – English)", "IKEA (Austria – German)", "IKEA (Austria – English)", "IKEA (Australia – English)", "IKEA (Belgium – English)", "IKEA (Belgium – French)", "IKEA (Belgium – Dutch)", "IKEA (Bahrain – Arabic)", "IKEA (Bahrain – English)", "IKEA (Canada – English)", "IKEA (Canada – French)", "IKEA (Switzerland – German)", "IKEA (Switzerland – English)", "IKEA (Switzerland – French)", "IKEA (Switzerland – Italian)", "IKEA (Chile – Spanish)", "IKEA (Colombia – Spanish)", "IKEA (Czech Republic – Czech)", "IKEA (Czech Republic – English)", "IKEA (Germany – German)", "IKEA (Germany – English)", "IKEA (Denmark – Danish)", "IKEA (Egypt – Arabic)", "IKEA (Egypt – English)", "IKEA (Finland – English)", "IKEA (Finland – Finnish)", "IKEA (France – French)", "IKEA (United Kingdom – English)", "IKEA (Croatia – Croatian)", "IKEA (Hungary – Hungarian)", "IKEA (Ireland – English)", "IKEA (Israel – Hebrew)", "IKEA (India – English)", "IKEA (Italy – Italian)", "IKEA (Jordan – Arabic)", "IKEA (Jordan – English)", "IKEA (Japan – English)", "IKEA (Japan – Japanese)", "IKEA (South Korea – English)", "IKEA (South Korea – Korean)", "IKEA (Kuwait – Arabic)", "IKEA (Kuwait – English)", "IKEA (Morocco – Arabic)", "IKEA (Morocco – English)", "IKEA (Morocco – French)", "IKEA (Mexico – English)", "IKEA (Mexico – Spanish)", "IKEA (Malaysia – English)", "IKEA (Malaysia – Malay)", "IKEA (Netherlands – English)", "IKEA (Netherlands – Dutch)", "IKEA (Norway – English)", "IKEA (Norway – Norwegian)", "IKEA (New Zealand – English)", "IKEA (Oman – Arabic)", "IKEA (Oman – English)", "IKEA (Philippines – English)", "IKEA (Poland – Polish)", "IKEA (Portugal – English)", "IKEA (Portugal – Portuguese)", "IKEA (Qatar – Arabic)", "IKEA (Qatar – English)", "IKEA (Romania – Romanian)", "IKEA (Serbia – Serbian)", "IKEA (Saudi Arabia – Arabic)", "IKEA (Saudi Arabia – English)", "IKEA (Sweden – English)", "IKEA (Sweden – Swedish)", "IKEA (Singapore – English)", "IKEA (Slovenia – Slovenian)", "IKEA (Slovakia – Slovak)", "IKEA (Thailand – English)", "IKEA (Thailand – Thai)", "IKEA (Ukraine – Ukrainian)", "IKEA (United States – English)", "IKEA (United States – Spanish)", "InsulationPoint", "John Lewis", "Kaufland (Germany)", "Kaufland (Czech Republic)", "Kaufland (Slovakia)", "Kaufland (Poland)", "Kaufland (Austria)", "Kaufland (Italy)", "Kaufland (France)", "Kohls", "Lidl (United Kingdom)", "Lowe's", "Macys", "M&S Food", "MediaMarkt", "Meijer", "Menswearhouse", "Mercado Libre (Argentina)", "Mercado Libre (Argentina)", "Mercado Libre (Argentina)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Brazil)", "Mercado Libre (Brazil)", "Mercado Libre (Brazil)", "Mercado Libre (Chile)", "Mercado Libre (Chile)", "Mercado Libre (Chile)", "Mercado Libre (Colombia)", "Mercado Libre (Colombia)", "Mercado Libre (Colombia)", "Mercado Libre (Costa Rica)", "Mercado Libre (Costa Rica)", "Mercado Libre (Costa Rica)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Ecuador)", "Mercado Libre (Ecuador)", "Mercado Libre (Ecuador)", "Mercado Libre (Guatemala)", "Mercado Libre (Guatemala)", "Mercado Libre (Guatemala)", "Mercado Libre (Honduras)", "Mercado Libre (Honduras)", "Mercado Libre (Honduras)", "Mercado Libre (Mexico)", "Mercado Libre (Mexico)", "Mercado Libre (Mexico)", "Mercado Libre (Nicaragua)", "Mercado Libre (Nicaragua)", "Mercado Libre (Nicaragua)", "Mercado Libre (Panama)", "Mercado Libre (Panama)", "Mercado Libre (Panama)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Peru)", "Mercado Libre (Peru)", "Mercado Libre (Peru)", "Mercado Libre (El Salvador)", "Mercado Libre (El Salvador)", "Mercado Libre (El Salvador)", "Mercado Libre (Uruguay)", "Mercado Libre (Uruguay)", "Mercado Libre (Uruguay)", "Mercado Libre (Venezuela)", "Mercado Libre (Venezuela)", "Mercado Libre (Venezuela)", "Morrisons", "MSC Industrial Supply", "Newegg", "Next", "Noon", "Nordstrom", "Ocado", "Petco", "Sainsbury's", "SalonCentric", "Sephora", "Smyths Toys", "Space NK", "Staples (Canada)", "Staples (United States)", "Superdrug", "Takealot", "Target", "Tesco", "Trendyol", "Uline (Canada)", "Uline (United States)", "Ulta Beauty", "Waitrose", "Walgreens", "Walmart (United States)", "Walmart (Canada)", "Wayfair" ] } }, "additionalProperties": { "title": "Include additional properties", "type": "boolean", "description": "Includes additional properties in the response." }, "fieldsToAnalyze": { "title": "AI summary - data points", "type": "array", "description": "Select the data point(s) you want to pass to ai. These selected data points will be used to generate a summary.", "items": { "type": "string", "enum": [ "image", "url", "name", "offers", "brand", "description", "additionalProperties" ] } }, "customPrompt": { "title": "AI summary - custom prompt", "maxLength": 3000, "type": "string", "description": "Enter a custom prompt to instruct ai how to process the data points. If left blank, Apify’s default prompt will be used." }, "maxProductResults": { "title": "Total maximum products", "minimum": 1, "type": "integer", "description": "Defines the total number of product results to collect during the entire run." }, "searchEngineKeyword": { "title": "Keyword search", "type": "string", "description": "Search terms for finding products. Enter one keyword per line up to 50 keywords. Each keyword runs as an independent search." }, "scrapeModeSearchEngine": { "title": "Scrape mode", "enum": [ "Google Listing", "Products", "Reviews", "Sellers" ], "type": "string", "description": "Select the type of data to scrape from Search engine results.", "default": "Google Listing" }, "countryCode": { "title": "Country codes", "enum": [ "af", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "kh", "cm", "ca", "cv", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "il", "it", "jm", "jp", "jo", "kz", "ke", "ki", "kp", "kr", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mk", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "an", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "sh", "kn", "lc", "pm", "vc", "ws", "sm", "st", "sa", "sn", "cs", "sc", "sl", "sg", "sk", "si", "sb", "so", "za", "gs", "es", "lk", "sd", "sr", "sj", "sz", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "us", "um", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw" ], "type": "string", "description": "Select the country/region to use for the Search Engine search context (affects currency, shipping, and availability). Default is United States (us).", "default": "us" }, "citySearchEngine": { "title": "City", "type": "string", "description": "City name to localize Search Engine results (e.g. 'New York', 'London')." }, "regionSearchEngine": { "title": "Region", "type": "string", "description": "Region or state name to localize Search Engine results (e.g. 'California', 'Bavaria')." }, "additionalPropertiesSearchEngine": { "title": "Include additional properties", "type": "boolean", "description": "Includes additional properties in the products scrape response." }, "maxSearchEngineProducts": { "title": "Maximum products per page", "minimum": 1, "type": "integer", "description": "Defines the maximum number of products to collect from a single Search Engine search results page during the run." }, "maxSearchEngineSellersPerProduct": { "title": "Maximum sellers per product", "minimum": 1, "type": "integer", "description": "Defines the maximum number of sellers to collect for each product found in Search Engine search results." }, "maxSearchEngineResults": { "title": "Total maximum search engine results", "minimum": 1, "type": "integer", "description": "Defines the total limit of items (products, sellers, or reviews) to be collected during the run. This limit applies specifically to the Search Engine mode." }, "keywordDelivery": { "title": "Keyword for search", "type": "string", "description": "Search keyword used to find delivery products across selected delivery marketplaces." }, "marketplacesDelivery": { "title": "Marketplaces for keyword search", "type": "array", "description": "Specifies which delivery marketplaces will be used for keyword-based product search.", "items": { "type": "string", "enum": [ "www.doordash.com", "www.glovoapp.com", "www.instacart.com", "www.wolt.com" ], "enumTitles": [ "Doordash", "Glovo", "Instacart", "Wolt" ] } }, "deliveryDetailsUrls": { "title": "Delivery product detail URLs", "type": "array", "description": "Direct links to individual delivery product pages. Each URL will be processed separately to extract product and review data.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "deliveryListingUrls": { "title": "Delivery listing URLs", "type": "array", "description": "Links to delivery category or listing pages. Products found on these pages will be processed automatically.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "addressDelivery": { "title": "Delivery address or location", "type": "string", "description": "Delivery location (e.g. city, ZIP code, or full address) used to localize delivery product availability and results." }, "scrapeReviewsDelivery": { "title": "Include extended delivery review data", "type": "boolean", "description": "When enabled, reviews will be included in the output." }, "maxDeliveryResults": { "title": "Total maximum results", "minimum": 1, "type": "integer", "description": "Defines the maximum total number of delivery products or reviews to collect across the entire run." }, "reviewDetailsUrls": { "title": "Review detail URLs", "type": "array", "description": "Direct links to individual product detail pages. Each page will be visited separately to extract review information.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "reviewListingUrls": { "title": "Review listing URLs", "type": "array", "description": "Links to pages with multiple product reviews. The scraper will collect all reviews from these listings.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywordReviews": { "title": "Keyword for search", "type": "string", "description": "A keyword used to search for product reviews across marketplaces." }, "marketplacesReviews": { "title": "Marketplaces for keyword search", "type": "array", "description": "Select the marketplaces where the keyword search should be performed for reviews.", "items": { "type": "string", "enum": [ "www.academy.com", "www.ae.com", "www.albertsons.com", "www.aldi.co.uk", "www.alibaba.com", "allegro.pl", "allegro.sk", "allegro.cz", "www.alza.cz", "www.alza.sk", "www.alza.hu", "www.alza.at", "www.alza.de", "www.amazon.ae", "www.amazon.ca", "www.amazon.cn", "www.amazon.co.jp", "www.amazon.co.uk", "www.amazon.com", "www.amazon.com.au", "www.amazon.com.be", "www.amazon.com.br", "www.amazon.com.mx", "www.amazon.com.sg", "www.amazon.com.tr", "www.amazon.de", "www.amazon.eg", "www.amazon.es", "www.amazon.fr", "www.amazon.ie", "www.amazon.in", "www.amazon.it", "www.amazon.nl", "www.amazon.pl", "www.amazon.sa", "www.amazon.se", "www.anthropologie.com", "www.ao.com", "www.argos.co.uk", "www.ariat.com", "www.asda.com", "www.ashleyfurniture.com", "www.autozone.com", "www.barnesandnoble.com", "www.basspro.com", "www.bestbuy.com", "www.bestbuy.ca", "www.bjs.com", "www.bloomingdales.com", "www.bluemercury.com", "www.bol.com", "www.boots.com", "www.cdiscount.com", "www.chewy.com", "www.coles.com.au", "www.coop.co.uk", "www.costco.com", "www.costco.ca", "www.cvs.com", "www.dickssportinggoods.com", "www.ebay.com", "www.ebay.co.uk", "www.ebay.de", "www.ebay.fr", "www.ebay.it", "www.ebay.es", "www.ebay.com.au", "www.ebay.ca", "www.galaxus.ch", "www.goofish.com", "www.grainger.ca", "www.grainger.com", "www.harborfreight.com", "www.hepsiburada.com", "www.homedepot.com", "www.iceland.co.uk", "www.idealo.at", "www.idealo.co.uk", "www.idealo.de", "www.idealo.es", "www.idealo.fr", "www.idealo.it", "www.ikea.com", "www.ikea.com/ae/ar", "www.ikea.com/ae/en", "www.ikea.com/at/de", "www.ikea.com/at/en", "www.ikea.com/au/en", "www.ikea.com/be/en", "www.ikea.com/be/fr", "www.ikea.com/be/nl", "www.ikea.com/bh/ar", "www.ikea.com/bh/en", "www.ikea.com/ca/en", "www.ikea.com/ca/fr", "www.ikea.com/ch/de", "www.ikea.com/ch/en", "www.ikea.com/ch/fr", "www.ikea.com/ch/it", "www.ikea.com/cl/es", "www.ikea.com/co/es", "www.ikea.com/cz/cs", "www.ikea.com/cz/en", "www.ikea.com/de/de", "www.ikea.com/de/en", "www.ikea.com/dk/da", "www.ikea.com/eg/ar", "www.ikea.com/eg/en", "www.ikea.com/fi/en", "www.ikea.com/fi/fi", "www.ikea.com/fr/fr", "www.ikea.com/gb/en", "www.ikea.com/hr/hr", "www.ikea.com/hu/hu", "www.ikea.com/ie/en", "www.ikea.com/il/he", "www.ikea.com/in/en", "www.ikea.com/it/it", "www.ikea.com/jo/ar", "www.ikea.com/jo/en", "www.ikea.com/jp/en", "www.ikea.com/jp/ja", "www.ikea.com/kr/en", "www.ikea.com/kr/ko", "www.ikea.com/kw/ar", "www.ikea.com/kw/en", "www.ikea.com/ma/ar", "www.ikea.com/ma/en", "www.ikea.com/ma/fr", "www.ikea.com/mx/en", "www.ikea.com/mx/es", "www.ikea.com/my/en", "www.ikea.com/my/ms", "www.ikea.com/nl/en", "www.ikea.com/nl/nl", "www.ikea.com/no/en", "www.ikea.com/no/no", "www.ikea.com/nz/en", "www.ikea.com/om/ar", "www.ikea.com/om/en", "www.ikea.com/ph/en", "www.ikea.com/pl/pl", "www.ikea.com/pt/en", "www.ikea.com/pt/pt", "www.ikea.com/qa/ar", "www.ikea.com/qa/en", "www.ikea.com/ro/ro", "www.ikea.com/rs/sr", "www.ikea.com/sa/ar", "www.ikea.com/sa/en", "www.ikea.com/se/en", "www.ikea.com/se/sv", "www.ikea.com/sg/en", "www.ikea.com/si/sl", "www.ikea.com/sk/sk", "www.ikea.com/th/en", "www.ikea.com/th/th", "www.ikea.com/ua/uk", "www.ikea.com/us/en", "www.ikea.com/us/es", "www.insulationpoint.co.uk", "www.johnlewis.com", "www.kaufland.de", "www.kaufland.cz", "www.kaufland.sk", "www.kaufland.pl", "www.kaufland.at", "www.kaufland.it", "www.kaufland.fr", "www.kohls.com", "www.lidl.co.uk", "www.lowes.com", "www.macys.com", "www.marksandspencer.com", "www.mediamarkt.de", "www.meijer.com", "www.menswearhouse.com", "www.mercadolibre.com.ar", "listado.mercadolibre.com.ar", "articulo.mercadolibre.com.ar", "www.mercadolibre.com.bo", "listado.mercadolibre.com.bo", "articulo.mercadolibre.com.bo", "servicio.mercadolibre.com.bo", "www.mercadolivre.com.br", "lista.mercadolivre.com.br", "produto.mercadolivre.com.br", "www.mercadolibre.cl", "listado.mercadolibre.cl", "articulo.mercadolibre.cl", "www.mercadolibre.com.co", "listado.mercadolibre.com.co", "articulo.mercadolibre.com.co", "www.mercadolibre.co.cr", "listado.mercadolibre.co.cr", "articulo.mercadolibre.co.cr", "www.mercadolibre.com.do", "listado.mercadolibre.com.do", "articulo.mercadolibre.com.do", "www.mercadolibre.com.ec", "listado.mercadolibre.com.ec", "articulo.mercadolibre.com.ec", "www.mercadolibre.com.gt", "listado.mercadolibre.com.gt", "articulo.mercadolibre.com.gt", "www.mercadolibre.com.hn", "listado.mercadolibre.com.hn", "articulo.mercadolibre.com.hn", "www.mercadolibre.com.mx", "listado.mercadolibre.com.mx", "articulo.mercadolibre.com.mx", "www.mercadolibre.com.ni", "listado.mercadolibre.com.ni", "articulo.mercadolibre.com.ni", "www.mercadolibre.com.pa", "listado.mercadolibre.com.pa", "articulo.mercadolibre.com.pa", "www.mercadolibre.com.py", "listado.mercadolibre.com.py", "articulo.mercadolibre.com.py", "servicio.mercadolibre.com.py", "www.mercadolibre.com.pe", "listado.mercadolibre.com.pe", "articulo.mercadolibre.com.pe", "www.mercadolibre.com.sv", "listado.mercadolibre.com.sv", "articulo.mercadolibre.com.sv", "www.mercadolibre.com.uy", "listado.mercadolibre.com.uy", "articulo.mercadolibre.com.uy", "www.mercadolibre.com.ve", "listado.mercadolibre.com.ve", "articulo.mercadolibre.com.ve", "groceries.morrisons.com", "www.mscdirect.com", "www.newegg.com", "www.next.co.uk", "www.noon.com", "www.nordstrom.com", "www.ocado.com", "www.petco.com", "www.sainsburys.co.uk", "www.saloncentric.com", "www.sephora.com", "www.smythstoys.com", "www.spacenk.com", "www.staples.ca", "www.staples.com", "www.superdrug.com", "www.takealot.com", "www.target.com", "www.tesco.com", "www.trendyol.com", "www.uline.ca", "www.uline.com", "www.ulta.com", "www.waitrose.com", "www.walgreens.com", "www.walmart.com", "www.walmart.ca", "www.wayfair.com" ], "enumTitles": [ "Academy Sports + Outdoors", "American Eagle", "Albertsons", "Aldi (United Kingdom)", "Alibaba", "Allegro (Poland)", "Allegro (Slovakia)", "Allegro (Czech Republic)", "Alza (Czech Republic)", "Alza (Slovakia)", "Alza (Hungary)", "Alza (Austria)", "Alza (Germany)", "Amazon (United Arab Emirates)", "Amazon (Canada)", "Amazon (China)", "Amazon (Japan)", "Amazon (United Kingdom)", "Amazon (United States)", "Amazon (Australia)", "Amazon (Belgium)", "Amazon (Brazil)", "Amazon (Mexico)", "Amazon (Singapore)", "Amazon (Turkey)", "Amazon (Germany)", "Amazon (Egypt)", "Amazon (Spain)", "Amazon (France)", "Amazon (Ireland)", "Amazon (India)", "Amazon (Italy)", "Amazon (Netherlands)", "Amazon (Poland)", "Amazon (Saudi Arabia)", "Amazon (Sweden)", "Anthropologie", "AO", "Argos", "Ariat", "Asda", "Ashleyfurniture", "AutoZone", "Barnes & Noble", "Bass Pro Shops", "BestBuy (United States)", "BestBuy (Canada)", "BJ's Wholesale Club", "Bloomingdale's", "Bluemercury", "Bol", "Boots", "Cdiscount", "Chewy", "Coles", "Co-op (United Kingdom)", "Costco (United States)", "Costco (Canada)", "CVS", "Dick's Sporting Goods", "eBay.com", "eBay (UK)", "eBay (Germany)", "eBay (France)", "eBay (Italy)", "eBay (Spain)", "eBay (Australia)", "eBay (Canada)", "Galaxus", "Goofish", "Grainger (Canada)", "Grainger (United States)", "Harbor Freight", "Hepsiburada", "Home Depot", "Iceland", "Idealo (Austria)", "Idealo (United Kingdom)", "Idealo (Germany)", "Idealo (Spain)", "Idealo (France)", "Idealo (Italy)", "IKEA", "IKEA (United Arab Emirates – Arabic)", "IKEA (United Arab Emirates – English)", "IKEA (Austria – German)", "IKEA (Austria – English)", "IKEA (Australia – English)", "IKEA (Belgium – English)", "IKEA (Belgium – French)", "IKEA (Belgium – Dutch)", "IKEA (Bahrain – Arabic)", "IKEA (Bahrain – English)", "IKEA (Canada – English)", "IKEA (Canada – French)", "IKEA (Switzerland – German)", "IKEA (Switzerland – English)", "IKEA (Switzerland – French)", "IKEA (Switzerland – Italian)", "IKEA (Chile – Spanish)", "IKEA (Colombia – Spanish)", "IKEA (Czech Republic – Czech)", "IKEA (Czech Republic – English)", "IKEA (Germany – German)", "IKEA (Germany – English)", "IKEA (Denmark – Danish)", "IKEA (Egypt – Arabic)", "IKEA (Egypt – English)", "IKEA (Finland – English)", "IKEA (Finland – Finnish)", "IKEA (France – French)", "IKEA (United Kingdom – English)", "IKEA (Croatia – Croatian)", "IKEA (Hungary – Hungarian)", "IKEA (Ireland – English)", "IKEA (Israel – Hebrew)", "IKEA (India – English)", "IKEA (Italy – Italian)", "IKEA (Jordan – Arabic)", "IKEA (Jordan – English)", "IKEA (Japan – English)", "IKEA (Japan – Japanese)", "IKEA (South Korea – English)", "IKEA (South Korea – Korean)", "IKEA (Kuwait – Arabic)", "IKEA (Kuwait – English)", "IKEA (Morocco – Arabic)", "IKEA (Morocco – English)", "IKEA (Morocco – French)", "IKEA (Mexico – English)", "IKEA (Mexico – Spanish)", "IKEA (Malaysia – English)", "IKEA (Malaysia – Malay)", "IKEA (Netherlands – English)", "IKEA (Netherlands – Dutch)", "IKEA (Norway – English)", "IKEA (Norway – Norwegian)", "IKEA (New Zealand – English)", "IKEA (Oman – Arabic)", "IKEA (Oman – English)", "IKEA (Philippines – English)", "IKEA (Poland – Polish)", "IKEA (Portugal – English)", "IKEA (Portugal – Portuguese)", "IKEA (Qatar – Arabic)", "IKEA (Qatar – English)", "IKEA (Romania – Romanian)", "IKEA (Serbia – Serbian)", "IKEA (Saudi Arabia – Arabic)", "IKEA (Saudi Arabia – English)", "IKEA (Sweden – English)", "IKEA (Sweden – Swedish)", "IKEA (Singapore – English)", "IKEA (Slovenia – Slovenian)", "IKEA (Slovakia – Slovak)", "IKEA (Thailand – English)", "IKEA (Thailand – Thai)", "IKEA (Ukraine – Ukrainian)", "IKEA (United States – English)", "IKEA (United States – Spanish)", "InsulationPoint", "John Lewis", "Kaufland (Germany)", "Kaufland (Czech Republic)", "Kaufland (Slovakia)", "Kaufland (Poland)", "Kaufland (Austria)", "Kaufland (Italy)", "Kaufland (France)", "Kohls", "Lidl (United Kingdom)", "Lowe's", "Macys", "M&S Food", "MediaMarkt", "Meijer", "Menswearhouse", "Mercado Libre (Argentina)", "Mercado Libre (Argentina)", "Mercado Libre (Argentina)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Bolivia)", "Mercado Libre (Brazil)", "Mercado Libre (Brazil)", "Mercado Libre (Brazil)", "Mercado Libre (Chile)", "Mercado Libre (Chile)", "Mercado Libre (Chile)", "Mercado Libre (Colombia)", "Mercado Libre (Colombia)", "Mercado Libre (Colombia)", "Mercado Libre (Costa Rica)", "Mercado Libre (Costa Rica)", "Mercado Libre (Costa Rica)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Dominican Republic)", "Mercado Libre (Ecuador)", "Mercado Libre (Ecuador)", "Mercado Libre (Ecuador)", "Mercado Libre (Guatemala)", "Mercado Libre (Guatemala)", "Mercado Libre (Guatemala)", "Mercado Libre (Honduras)", "Mercado Libre (Honduras)", "Mercado Libre (Honduras)", "Mercado Libre (Mexico)", "Mercado Libre (Mexico)", "Mercado Libre (Mexico)", "Mercado Libre (Nicaragua)", "Mercado Libre (Nicaragua)", "Mercado Libre (Nicaragua)", "Mercado Libre (Panama)", "Mercado Libre (Panama)", "Mercado Libre (Panama)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Paraguay)", "Mercado Libre (Peru)", "Mercado Libre (Peru)", "Mercado Libre (Peru)", "Mercado Libre (El Salvador)", "Mercado Libre (El Salvador)", "Mercado Libre (El Salvador)", "Mercado Libre (Uruguay)", "Mercado Libre (Uruguay)", "Mercado Libre (Uruguay)", "Mercado Libre (Venezuela)", "Mercado Libre (Venezuela)", "Mercado Libre (Venezuela)", "Morrisons", "MSC Industrial Supply", "Newegg", "Next", "Noon", "Nordstrom", "Ocado", "Petco", "Sainsbury's", "SalonCentric", "Sephora", "Smyths Toys", "Space NK", "Staples (Canada)", "Staples (United States)", "Superdrug", "Takealot", "Target", "Tesco", "Trendyol", "Uline (Canada)", "Uline (United States)", "Ulta Beauty", "Waitrose", "Walgreens", "Walmart (United States)", "Walmart (Canada)", "Wayfair" ] } }, "sortReview": { "title": "Review sort type", "enum": [ "Most recent", "Most relevant", "Most helpful", "Highest rated", "Lowest rated" ], "type": "string", "description": "Select how product reviews should be sorted. Some marketplaces may not support all sorting options — in such cases, the scraper will fall back to the default.", "default": "Most recent" }, "additionalReviewProperties": { "title": "Include additional review properties", "type": "boolean", "description": "Includes additional properties in the response." }, "maxReviewResults": { "title": "Total maximum reviews", "minimum": 1, "type": "integer", "description": "Defines the total number of review results to collect during the entire run." }, "sellerUrls": { "title": "Seller profile URLs", "type": "array", "description": "Direct links to seller profile or store pages. Each URL will be visited to extract detailed seller information.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxSellerResults": { "title": "Total maximum sellers", "minimum": 1, "type": "integer", "description": "Defines the total number of seller results to collect during the entire run." }, "influencerUrls": { "title": "Influencer URLs", "type": "array", "description": "Direct links to individual influencer pages. Each page will be visited separately to extract post information.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeInfluencerProducts": { "title": "Scrape influencer post products", "type": "boolean", "description": "Scrape products from influencer posts." }, "maxInfluencerResults": { "title": "Total maximum influencer results", "minimum": 1, "type": "integer", "description": "Limits the total number of influencer posts or items to collect during the run." } } }, "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 } } }, "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 } } } } } } } } } }