{ "openapi": "3.0.1", "info": { "title": "Woolworths AU Scraper - Prices & Stock by Store, Specials", "description": "Woolworths Australia prices and stock for any of the 1,142 supermarkets. Search, paste any link, look up barcodes, or scrape specials with offer dates and the full catalog. Add nutrition, allergens, customer reviews, Everyday Market sellers, or every store's address and opening hours.", "version": "0.0", "x-build-id": "Vd0fqBqafhXj5tEvY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~woolworths-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-woolworths-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/clearpath~woolworths-scraper/runs": { "post": { "operationId": "runs-sync-clearpath-woolworths-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/clearpath~woolworths-scraper/run-sync": { "post": { "operationId": "run-sync-clearpath-woolworths-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": { "searchTerms": { "title": "🔍 Search terms", "maxItems": 100, "type": "array", "description": "Products to search for on Woolworths, one per line. Up to 100 per run.", "items": { "type": "string" } }, "startUrls": { "title": "🔗 Woolworths links", "maxItems": 1000, "type": "array", "description": "Paste any Woolworths link: a product, category, specials page, search results, store page or multi-buy offer. Filters and sorting in the link are kept. Up to 1,000 per run. Paste the links themselves, a link list file is not read.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "barcodes": { "title": "🏷️ Barcodes", "maxItems": 1000, "type": "array", "description": "Look up products by barcode (EAN/GTIN). Only exact matches are returned. Up to 1,000 per run.", "items": { "type": "string" } }, "specials": { "title": "💲 Specials", "enum": [ "none", "all", "halfprice", "multibuy", "lowershelfprice", "everydaylowprice", "seasonal", "onlineonly", "bundles" ], "type": "string", "description": "Scrape everything on special or with a lower price, or one kind of deal.", "default": "none" }, "departments": { "title": "🗂️ Departments", "type": "array", "description": "Whole departments, picked from the list. For one aisle or shelf, paste its link above instead.", "items": { "type": "string", "enum": [ "fruit-veg", "poultry-meat-seafood", "dinner", "deli", "dairy-eggs-fridge", "bakery", "lunch-box", "freezer", "snacks-confectionery", "pantry", "international-foods", "drinks", "beer-wine-spirits", "beauty", "personal-care", "health-wellness", "cleaning-maintenance", "baby", "pet", "electronics", "home-lifestyle" ], "enumTitles": [ "Fruit & Veg", "Poultry, Meat & Seafood", "Dinner", "Deli", "Dairy, Eggs & Fridge", "Bakery", "Lunch Box", "Freezer", "Snacks & Confectionery", "Pantry", "International Foods", "Drinks", "Beer, Wine & Spirits", "Beauty", "Personal Care", "Health & Wellness", "Cleaning & Maintenance", "Baby", "Pet", "Electronics", "Home & Lifestyle" ] } }, "fullCatalog": { "title": "📦 Full catalog", "type": "boolean", "description": "Every product Woolworths sells, department by department, duplicates removed. Pick Departments above to narrow it. Everyday Market listings are not included.", "default": false }, "storeDirectory": { "title": "📍 Store directory", "type": "boolean", "description": "Every Woolworths supermarket: address, phone, coordinates, opening hours for the next 7 days and facilities.", "default": false }, "everydayMarketSellers": { "title": "Everyday Market sellers", "maxItems": 50, "type": "array", "description": "Seller names exactly as shown on Woolworths, for example JOYBUY ONLINE. Returns the seller's Everyday Market listings.", "items": { "type": "string" } }, "maxItems": { "title": "🔢 Maximum products", "minimum": 0, "type": "integer", "description": "Per search term, link, department, specials type or seller, per store. Leave empty or set 0 for no limit. Keeps a run small and the cost predictable." }, "storeIds": { "title": "Store IDs", "maxItems": 2000, "type": "array", "description": "Woolworths store numbers, for example 1002 in woolworths.com.au/shop/storelocator/nsw-chatswood-1002. Each store gets its own rows.", "items": { "type": "string" } }, "postcodes": { "title": "Postcodes", "maxItems": 500, "type": "array", "description": "Australian postcodes. Each one uses the nearest Woolworths supermarket. Up to 500 per run.", "items": { "type": "string" } }, "allStores": { "title": "All Woolworths supermarkets", "type": "boolean", "description": "Your searches, links, specials and catalog in every Woolworths supermarket (about 1,140). Rows multiply by the number of stores: combine with a small maximum.", "default": false }, "includeDetails": { "title": "Include product details", "type": "boolean", "description": "Adds the nutrition panel, country of origin label, directions, warnings, aisle and every variant. Barcode, ingredients, allergens and dietary claims are always included. Charged as an add-on per product. Product links and barcodes always come with details and are charged the same add-on.", "default": false }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Adds review rows (rating, text, date, author) and the star rating breakdown for each product. Each review is charged as a review event.", "default": false }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 0, "type": "integer", "description": "Newest reviews first. Leave empty or set 0 for all reviews." }, "includeEverydayMarket": { "title": "Include Everyday Market", "type": "boolean", "description": "Also return Everyday Market listings (products from third-party sellers, shipped by the seller) in searches, links and specials. Off by default: they are not sold in stores and can outnumber Woolworths products many times.", "default": false }, "categories": { "title": "🗂️ Category tree", "type": "boolean", "description": "Adds one row per Woolworths category: name, path, level and link. Use it to build a category list or to find the exact category link you want to scrape.", "default": false }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "priceAscending", "priceDescending", "unitPriceAscending", "unitPriceDescending", "nameAscending", "nameDescending", "newest", "specialsFirst" ], "type": "string", "description": "Order results the way Woolworths sorts them. Links that already contain a sort order keep it.", "default": "relevance" }, "brands": { "title": "Brands", "type": "array", "description": "Only these brands, exactly as Woolworths writes them.", "items": { "type": "string" } }, "dietary": { "title": "Dietary and lifestyle", "type": "array", "description": "For example Gluten Free, Vegan, Halal, Kosher, Organic, Low Sugar. Products match any of them.", "items": { "type": "string" } }, "allergenFree": { "title": "Allergen free", "type": "array", "description": "For example Dairy Free, Egg Free, Peanut Free, Soy Free, Tree Nut Free. Products match any of them.", "items": { "type": "string" } }, "minHealthStarRating": { "title": "Minimum Health Star Rating", "enum": [ "0.5", "1", "1.5", "2", "2.5", "3", "3.5", "4", "4.5", "5" ], "type": "string", "description": "Only products rated at least this." }, "onlySpecials": { "title": "Only products on special", "type": "boolean", "description": "Keep only discounted products.", "default": false }, "inStockOnly": { "title": "Only in stock", "type": "boolean", "description": "Skip products that are out of stock.", "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 } } }, "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 } } } } } } } } } }