{ "openapi": "3.0.1", "info": { "title": "Product Price & Stock Scraper: Shopify, WooCommerce", "description": "Scrape product prices and stock from Shopify, WooCommerce, Magento, Shopware, PrestaShop, BigCommerce, Wix and Squarespace shops, not marketplaces. Give product URLs, whole shops or search terms; get one row per product: price, currency, stock, SKU, GTIN/EAN. For e-commerce price monitoring.", "version": "0.2", "x-build-id": "XGDyMcbi188u38R7c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/victorix~product-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-victorix-product-price-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/victorix~product-price-scraper/runs": { "post": { "operationId": "runs-sync-victorix-product-price-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/victorix~product-price-scraper/run-sync": { "post": { "operationId": "run-sync-victorix-product-price-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": { "productUrls": { "title": "🔗 Product page URLs", "maxItems": 10000, "type": "array", "description": "Give at least one product page here or one shop in Whole shops. Product pages to read, one per line, up to 10,000; a URL without https:// is read as https. Each page gives one row per product it sells: usually one, several on a page that sells several products, or one per variant when you switch that on below.", "items": { "type": "string" } }, "shopUrls": { "title": "🏬 Whole shops", "maxItems": 1000, "type": "array", "description": "Give at least one shop here or one product page in Product page URLs. Shops to read whole, one per line, up to 1,000; the home page is enough, for example https://warehouse-theme-metal.myshopify.com/. A collection or category page instead reads only that listing. Shopify shops are read through their catalogue feed, WooCommerce shops through their Store API, any other shop through the product pages its sitemap lists. Each product is one row, up to the maximum below.", "items": { "type": "string" } }, "searchTerms": { "title": "🔎 Search terms", "maxItems": 1000, "type": "array", "description": "Keywords to look for in every shop listed in Whole shops (at least one is needed), instead of reading the whole shop; up to 1,000, one per line, for example wireless headphones, SW-10001 or 5901234123457. A product matches when every word is in its name, or when the keyword is its SKU or barcode. Shopify and WooCommerce shops are searched through their own catalogue; other shops through the addresses of their product pages (best effort).", "items": { "type": "string" } }, "maxProductsPerShop": { "title": "🔢 Maximum products per shop", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop each whole shop after this many products: 1 to 100,000, default 1,000. With search terms, it caps each term's rows in each shop. Combine it with the run's maximum total charge to cap the cost; product page URLs are not counted here.", "default": 1000 }, "oneRowPerVariant": { "title": "🧩 One row per variant", "type": "boolean", "description": "Off (the default): one row per product, at its lowest price, in stock when any variant is, with variantCount saying how many variants it has. On: one row per variant (size, colour), each charged as a result.", "default": false }, "includeDescription": { "title": "📝 Include descriptions", "type": "boolean", "description": "Add each product's description as plain text. Turn it off for smaller rows.", "default": true }, "proxyConfiguration": { "title": "🛡️ Proxy", "type": "object", "description": "Which proxy the pages are fetched through. The default is Apify's datacenter proxy. For residential IPs, give your own proxy URLs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }