{ "openapi": "3.0.1", "info": { "title": "E-commerce Product Scraper for Any Online Store", "description": "Products from any online store: price, sale price, stock, variants, SKU, GTIN, rating, images. Give a store to read its whole catalog, or product pages. Schedule it to get price drops, stock changes, new and removed products. Shopify, WooCommerce and more.", "version": "1.0", "x-build-id": "JChTwyxmHTngSASIS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digital_influx~product-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digital_influx-product-data", "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/digital_influx~product-data/runs": { "post": { "operationId": "runs-sync-digital_influx-product-data", "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/digital_influx~product-data/run-sync": { "post": { "operationId": "run-sync-digital_influx-product-data", "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": { "storeUrls": { "title": "Stores (whole catalog)", "type": "array", "description": "One store per line, for example allbirds.com. The Actor finds the product pages in the store's sitemap (Shopify, WooCommerce, BigCommerce, Salesforce and most platforms publish one) and reads up to the limit below.", "items": { "type": "string" } }, "productUrls": { "title": "Product pages", "type": "array", "description": "One product page per line, from any store. Pages without product data are saved free with a status that says why.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many products to read from each store (1 to 5000). Product pages you list yourself are always read.", "default": 100 }, "compareWithPreviousRun": { "title": "Compare with the previous run (price monitoring)", "type": "boolean", "description": "For scheduled runs: each product gets \"changes\" (new product, price change with amount and percent, stock change) against the last time it was read, and each store row counts price drops, increases, products back in stock or sold out, and products removed from the store. What each product cost is kept in a key-value store named \"product-data-state\" in your account.", "default": false }, "onlyChanges": { "title": "Only save products that changed", "type": "boolean", "description": "With monitoring on: products whose price and stock did not change are not saved (they are still read and charged, since the check is the work).", "default": false }, "minPriceChangePercent": { "title": "Minimum price change (%)", "minimum": 0, "maximum": 90, "type": "integer", "description": "With monitoring on: price changes smaller than this percent are not reported (0 = every change). The last reported price stays the reference, so small changes that add up are reported once the total passes the threshold.", "default": 0 }, "stateKey": { "title": "Memory name (optional)", "type": "string", "description": "Give a name to keep a separate price history, for example one per client, or a new name to start over." }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Each size, color or pack with its own price, SKU, GTIN and stock (up to 100 per product).", "default": true }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "The product description (first 1000 characters).", "default": true }, "maxConcurrency": { "title": "Stores in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many stores are read at the same time (1 to 10). Each store is read at most 2 pages at a time, or one page at a time with the pause its robots.txt asks for (Crawl-delay).", "default": 4 } } }, "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 } } } } } } } } } }