{ "openapi": "3.0.1", "info": { "title": "Woolworths Scraper — Bulk Prices & CSV API", "description": "Collect Woolworths products, specials and delivered price-change observations with explicit source coverage. Bulk export: JSON, CSV, Excel and API. PPE: $1/1K product results; usage extra.", "version": "0.1", "x-build-id": "luPklJ7JUcr1RgsJa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apivault_labs~woolworths-products-price-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apivault_labs-woolworths-products-price-monitor", "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/apivault_labs~woolworths-products-price-monitor/runs": { "post": { "operationId": "runs-sync-apivault_labs-woolworths-products-price-monitor", "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/apivault_labs~woolworths-products-price-monitor/run-sync": { "post": { "operationId": "run-sync-apivault_labs-woolworths-products-price-monitor", "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": { "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Default Australian residential Apify Proxy. Your account needs access to this group; traffic costs apply. Direct access or one custom proxy URL can be configured in advanced settings.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "AU" } }, "mode": { "title": "Operation", "enum": [ "search", "category", "product", "categories", "catalog", "sitemap" ], "type": "string", "description": "Choose product search, a category, exact products, category discovery, a department catalogue snapshot, or product-link discovery.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Up to50 separate searches. Used in search mode.", "items": { "type": "string" } }, "strictKeywordMatch": { "title": "Require every search word", "type": "boolean", "description": "Search mode only. Require every search word in the product name, brand or description. Can exclude synonyms and broader relevant results.", "default": false }, "categoryId": { "title": "Category ID", "type": "string", "description": "Exact category ID returned by category discovery. Category mode also needs its categoryPath." }, "categoryPath": { "title": "Category path", "type": "string", "description": "Browse path, e.g. dairy-eggs-fridge/milk. No hostname or query string." }, "productIds": { "title": "Stockcodes or product URLs", "type": "array", "description": "Up to100 Woolworths stockcodes or HTTPS product links; product mode.", "items": { "type": "string" } }, "productTransport": { "title": "Advanced product-detail option", "enum": [ "html", "json" ], "type": "string", "description": "Advanced product-detail option. Keep the default unless you have verified that an alternative suits your collection. Sitemap mode requires html.", "default": "html" }, "maxItems": { "title": "Maximum products per run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Global cap after filtering/dedup. A capped run is marked incomplete.", "default": 100 }, "maxPages": { "title": "Maximum pages per source", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum pages per search or department. In sitemap mode, limits discovery documents. Time and product limits also apply.", "default": 10 }, "catalogResumeKey": { "title": "Catalogue snapshot key", "maxLength": 100, "type": "string", "description": "Catalog mode only. Resume a durable snapshot across runs under this key; original observedAt values are retained. A completed key replays the saved snapshot. Use a new key for fresh prices. Cannot combine with incrementalMode or includeDetails." }, "catalogPagesPerRun": { "title": "Catalogue pages per continuation", "minimum": 1, "maximum": 500, "type": "integer", "description": "Save catalogue progress after up to this many pages in one continuation. maxItems is the cumulative snapshot limit. Check coverage and errors before claiming completeness.", "default": 100 }, "catalogDepartmentIds": { "title": "Selected catalogue departments", "type": "array", "description": "Optional exact root department IDs returned by category discovery. Requires catalogResumeKey. Empty selects all grocery departments. Selected completion does not establish full-catalogue coverage.", "items": { "type": "string" } }, "maxRunSeconds": { "title": "Collection time budget", "minimum": 60, "maximum": 1800, "type": "integer", "description": "Collection stops safely at this budget or 20 seconds before platform timeout. Large catalog scans need a platform timeout above this budget. Partial scans never expire missing products.", "default": 480 }, "pageSize": { "title": "Products requested per page", "minimum": 1, "maximum": 36, "type": "integer", "description": "Products requested per page.", "default": 24 }, "sortBy": { "title": "Source ordering", "enum": [ "TraderRelevance", "PriceAsc", "PriceDesc", "CUPAsc", "CUPDesc", "Name", "NameDesc", "Specials", "AvailableDateDesc" ], "type": "string", "description": "Source ordering.", "default": "TraderRelevance" }, "specialsOnly": { "title": "Only specials", "type": "boolean", "description": "Only specials.", "default": false }, "inStockOnly": { "title": "Only confirmed in-stock products", "type": "boolean", "description": "Only confirmed in-stock products.", "default": false }, "brands": { "title": "Exact brand names", "type": "array", "description": "Case-insensitive exact matching.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum current price (AUD)", "minimum": 0, "type": "number", "description": "Minimum current price (AUD)." }, "maxPrice": { "title": "Maximum current price (AUD)", "minimum": 0, "type": "number", "description": "Maximum current price (AUD)." }, "minDiscountPercent": { "title": "Minimum discount (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Requires known positive savings calculated from current and was price. Unknown/no markdown products are excluded." }, "minHealthStarRating": { "title": "Minimum Health Star Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Requires a source-reported Health Star Rating. Missing ratings are excluded." }, "dietaryClaims": { "title": "Required dietary claims", "type": "array", "description": "Every requested claim must match an explicit source label, case-insensitive. Example: Vegetarian, Gluten Free. Unknown claims do not match; no safety or allergen-free inference.", "items": { "type": "string" } }, "includeMarketplace": { "title": "Include Everyday Market products", "type": "boolean", "description": "Include Everyday Market products.", "default": false }, "includeSponsored": { "title": "Include sponsored products", "type": "boolean", "description": "Include sponsored products.", "default": false }, "includeDetails": { "title": "Enrich label and nutrition", "type": "boolean", "description": "Requests details for a bounded subset. Product mode always reads details. Listing prices and stock are preserved during enrichment.", "default": false }, "maxDetailProducts": { "title": "Maximum detail requests", "minimum": 0, "maximum": 100, "type": "integer", "description": "Maximum detail requests.", "default": 20 }, "requestTimeoutSecs": { "title": "Response timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Response timeout.", "default": 30 }, "incrementalMode": { "title": "Emit changes between runs", "type": "boolean", "description": "Compare runs with a saved baseline and retain up to 20 actual dated observations per product. Avoid overlapping runs of the same monitoring campaign.", "default": false }, "stateKey": { "title": "Monitoring campaign", "maxLength": 100, "type": "string", "description": "Optional monitoring campaign name. Use a new name when changing queries or filters; an empty name uses the current collection settings." }, "emitUnchanged": { "title": "Also emit unchanged products", "type": "boolean", "description": "Also emit unchanged products.", "default": false }, "emitExpired": { "title": "Emit products no longer matching scope", "type": "boolean", "description": "Only after a complete scan; means no longer in this filtered result, not proof of product delisting.", "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 } } } } } } } } } }