{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper — Any Store URL, Price & Stock", "description": "Scrape product data from any store URL: name, brand, SKU, GTIN, price, sale price, currency, stock, variants, images and rating, from schema.org JSON-LD, microdata, OpenGraph and Shopify/WooCommerce fast paths. Price monitoring with change alerts. $2 per 1,000 products.", "version": "0.1", "x-build-id": "exPteIbHuE03nuVB3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/actor-forge~ecommerce-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-actor-forge-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/actor-forge~ecommerce-product-scraper/runs": { "post": { "operationId": "runs-sync-actor-forge-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/actor-forge~ecommerce-product-scraper/run-sync": { "post": { "operationId": "run-sync-actor-forge-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": { "urls": { "title": "Product URLs", "type": "array", "description": "Product page URLs from any store (Shopify, WooCommerce, BigCommerce, Magento, PrestaShop, Shopware, Wix, Squarespace or a custom site). With discover on, you can also give category pages, a homepage or sitemap.xml URLs. Duplicates and tracking parameters are removed.", "items": { "type": "string" } }, "url": { "title": "Single URL (alias)", "type": "string", "description": "One product, category or sitemap URL. Handy for Clay, Make, Zapier, n8n and AI agents. Scraped together with urls." }, "discover": { "title": "Discover product URLs", "type": "boolean", "description": "Treat each URL as a starting point. A sitemap.xml (or sitemap index) is read for its product URLs, a category or collection page gives its product links, and a homepage falls back to the sitemaps listed in robots.txt. Product pages are still scraped as themselves. Discovery is free; only product rows are charged.", "default": false }, "maxProducts": { "title": "Max product URLs", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most product URLs scraped in one run (given plus discovered). Each product found costs one product-result event. Set a maximum total charge on the run as an extra safety cap.", "default": 100 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Add every variant (name, SKU, GTIN, price, regular price, stock, options such as size and colour) to each row. On Shopify and WooCommerce this reads the store's public product JSON (one extra request). Same price.", "default": true }, "monitorName": { "title": "Monitor name (price & stock tracking)", "type": "string", "description": "Turns on change tracking. The last-seen price and stock of each URL are kept in your named key-value store products-, and every row gets a changed object: isNew, price, availability, previousPrice, previousAvailability. Schedule the same input daily for competitor price monitoring.", "default": "" }, "onlyChanges": { "title": "Only output changes", "type": "boolean", "description": "With a monitor name: output (and pay for) only products that are new or whose price or stock changed since the last run. Unchanged products are skipped and cost nothing. Pair it with a dataset webhook or integration for alerts.", "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 } } } } } } } } } }