{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper - Prices, Stock, GTIN & Variants", "description": "Scrape products from any online store for $0.45 per 1,000: price, sale price, currency, stock, brand, SKU, GTIN, images, rating, variants and breadcrumbs. Product, category, collection and search pages; Shopify, WooCommerce, VTEX and any schema.org store. Price monitor.", "version": "0.1", "x-build-id": "8CnYhXy7nTA9GCFWv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/topapi~ecommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-topapi-ecommerce-product-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/topapi~ecommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-topapi-ecommerce-product-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/topapi~ecommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-topapi-ecommerce-product-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Any online-store URL: a product page, a category or collection page, a search results page or a store home page. The page type is detected for you, e.g. https://www.allbirds.com/collections/mens", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "detailsUrls": { "title": "Product detail URLs", "type": "array", "description": "URLs you know are single product pages (read as products without detection), e.g. https://www.ikea.com/us/en/p/billy-bookcase-white-00263850/", "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 you know are category, collection or search pages: every product listed is read, following the store's pagination.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keyword": { "title": "Keyword search", "type": "string", "description": "Search for this term inside every store under \"Stores to search in\" (the store's own search), e.g. \"backpack\". Several keywords: use Keywords below." }, "keywords": { "title": "Keywords", "type": "array", "description": "More search terms, one per line. Each keyword is searched in each store.", "items": { "type": "string" } }, "storeUrls": { "title": "Stores to search in", "type": "array", "description": "Store domains or URLs for the keyword search, e.g. muji.us, nalgene.com, www.gymshark.com. Empty = the stores of your Start URLs.", "items": { "type": "string" } }, "maxListingPages": { "title": "Max listing pages per URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many pages of a category or search page to follow (platform feeds such as Shopify and WooCommerce read up to 250 / 100 products per page).", "default": 20 }, "onlyInStock": { "title": "Only in-stock products", "type": "boolean", "description": "Skip products the store marks out of stock (or sold out). Products the store gives no stock status for are skipped too.", "default": false }, "onlyOnSale": { "title": "Only discounted products", "type": "boolean", "description": "Keep products whose price is below the store's original / compare-at price.", "default": false }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Keep products priced at or above this amount, in the store's currency. Products without a price are skipped when set." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Keep products priced at or below this amount, in the store's currency. Products without a price are skipped when set." }, "onlyWithGtin": { "title": "Only products with a GTIN", "type": "boolean", "description": "Keep products with a barcode (GTIN / EAN / UPC / ISBN) on the product or one of its variants.", "default": false }, "updatedSince": { "title": "Updated since", "type": "string", "description": "Skip products the store says were last updated before this date (YYYY-MM-DD) or this many days ago (\"7 days\"). Stores that publish no update date (most non-Shopify stores) are not filtered." }, "urlIncludePatterns": { "title": "Only product URLs matching", "type": "array", "description": "Keep only products whose URL contains one of these texts or regular expressions, e.g. /mens- or /products/.*-boot. Applied to listing links before they are opened.", "items": { "type": "string" } }, "urlExcludePatterns": { "title": "Skip product URLs matching", "type": "array", "description": "Skip products whose URL contains one of these texts or regular expressions, e.g. gift-card or /sale/.", "items": { "type": "string" } }, "scrapeProductDetails": { "title": "Get product details", "type": "boolean", "description": "Open each product found on a listing for what only its page carries (rating, reviews, GTIN, breadcrumbs, shipping). Off = faster rows from the store's feed (Shopify, WooCommerce, VTEX).", "default": true }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Every size / colour / option the store lists, with its own SKU, barcode, price, stock and image.", "default": true }, "additionalProperties": { "title": "Include additional properties", "type": "boolean", "description": "Adds the product's other attributes (specifications table, colour, size, material, model, weight) as one object.", "default": true }, "includeReviews": { "title": "Include reviews on the page", "type": "boolean", "description": "Adds the reviews the product page publishes in its structured data (author, rating, title, text, date).", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap for the reviews array when reviews are included.", "default": 20 }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "The product description as plain text. Turn off for smaller rows (e.g. for AI agents).", "default": true }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Deliver only products new since the previous monitor run (and, with the switch below, products whose price or stock changed). Pairs with a daily schedule.", "default": false }, "monitorChanges": { "title": "Also deliver price / stock changes", "type": "boolean", "description": "In monitor mode, re-deliver a known product when its price, original price or availability changed, with the previous values and the changed fields named.", "default": true }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that remembers the products already delivered. Use one name per watch list.", "default": "ecommerce-product-monitor" }, "maxProductResults": { "title": "Total maximum products", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Products to deliver in this run across all inputs (0 = no limit). Shopify catalogue feeds go to 25,000 products per store; VTEX search to 2,500 per query.", "default": 50 }, "maxResultsPerUrl": { "title": "Max products per URL / search", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Cap per start URL or per keyword-and-store search (0 = no per-URL cap), so one big catalogue does not use up the total.", "default": 0 }, "compact": { "title": "Compact output", "type": "boolean", "description": "Core fields only (name, brand, price, original price, currency, stock, SKU, GTIN, image, rating, category, store, URL), trimmed for AI agents and spreadsheets.", "default": false }, "splitVariants": { "title": "One row per variant", "type": "boolean", "description": "Deliver each variant (size, colour...) as its own row with its own SKU, GTIN, price and stock (each row is charged as a product).", "default": false }, "descriptionMaxLength": { "title": "Max description length", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Cut descriptions to this many characters (0 = full text).", "default": 0 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Default: each store is read directly first, then through the Apify datacenter proxy, residential proxy and Unblocker only if it refuses. Pick a country to see that market's prices.", "default": { "useApifyProxy": true } }, "useResidentialFallback": { "title": "Residential proxy fallback", "type": "boolean", "description": "Let a store that refuses the datacenter route move to the Apify residential proxy (adds the residential surcharge per product read that way).", "default": true }, "useUnblockerFallback": { "title": "Unblocker fallback", "type": "boolean", "description": "Let a store that refuses even the residential proxy move to the Apify Unblocker (adds the Unblocker surcharge per product read that way).", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Pages fetched in parallel across all stores.", "default": 8 }, "maxConcurrencyPerStore": { "title": "Max concurrency per store", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages fetched in parallel from one store.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (s)", "minimum": 10, "maximum": 120, "type": "integer", "description": "Per page. The Unblocker always gets at least 90 s.", "default": 30 }, "maxRunSeconds": { "title": "Max run time (s)", "minimum": 0, "maximum": 86400, "type": "integer", "description": "Stop collecting after this many seconds and finish cleanly (0 = until the run timeout).", "default": 0 } } }, "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 } } } } } } } } } }