{ "openapi": "3.0.1", "info": { "title": "BIG W Product Scraper", "description": "Scrape BIG W (bigw.com.au) products at scale: price, was-price, savings, deals, GTIN/EAN barcodes, variants, images, specs, ratings and reviews. Search by keyword, browse categories, or pass product URLs. Clean JSON for price monitoring and research. Pay only for results.", "version": "1.0", "x-build-id": "q7QUbexdBzVlcEHAB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~bigw-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-bigw-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/axlymxp~bigw-product-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-bigw-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/axlymxp~bigw-product-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-bigw-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": { "searchQueries": { "title": "Search queries", "type": "array", "description": "Keywords to search on bigw.com.au (one search per keyword). Leave empty if you use category IDs or product URLs instead.", "default": [], "items": { "type": "string" } }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Browse whole categories by numeric category ID (found in a category URL: /.../c/, e.g. 68 = Toys). Returns every product in the category.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs or codes", "type": "array", "description": "Direct BIG W product page URLs (or bare numeric article IDs) to fetch full detail for.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items (total)", "minimum": 1, "type": "integer", "description": "Global cap across all queries, categories and URLs. The run stops once this many products are pushed.", "default": 200 }, "maxPagesPerQuery": { "title": "Max search pages per query", "minimum": 1, "maximum": 42, "type": "integer", "description": "Search/category pages per query (48 results per page). BIG W caps any single search at 2000 results — slice by category to go deeper.", "default": 5 }, "sort": { "title": "Sort order", "enum": [ "relevance", "nameAsc", "nameDesc", "priceAsc", "priceDesc" ], "type": "string", "description": "Result ordering for searches and category browses.", "default": "relevance" }, "onlyInStock": { "title": "Only in-stock products", "type": "boolean", "description": "Return only products that are currently in stock.", "default": false }, "minPrice": { "title": "Minimum price (AUD)", "minimum": 0, "type": "integer", "description": "Only include products priced at or above this amount (in dollars)." }, "maxPrice": { "title": "Maximum price (AUD)", "minimum": 0, "type": "integer", "description": "Only include products priced at or below this amount (in dollars)." }, "brands": { "title": "Brands", "type": "array", "description": "Restrict results to these brand names (exact names as shown on BIG W, e.g. 'LEGO').", "default": [], "items": { "type": "string" } }, "soldBy": { "title": "Sold by", "enum": [ "", "BIG W", "Marketplace Seller" ], "type": "string", "description": "Restrict to BIG W's own stock or third-party Marketplace sellers.", "default": "" }, "includeFullDetail": { "title": "Include full detail (description + variants)", "type": "boolean", "description": "Fetch the full product detail (long description, variants with per-colour/size barcodes). One extra request per product.", "default": true }, "includePricing": { "title": "Include live pricing (was-price, RRP, savings)", "type": "boolean", "description": "Fetch the live price (current price, was-price, RRP, save amount, promo badge, unit price). One extra request per product.", "default": true }, "includeReviewStats": { "title": "Include rating summary", "type": "boolean", "description": "Fetch the Bazaarvoice rating summary (average rating, review count, recommended count, star distribution). One extra request per product.", "default": true }, "includeReviews": { "title": "Include customer reviews", "type": "boolean", "description": "Fetch individual customer reviews (title, text, rating, author, pros/cons, photos) nested in each product row.", "default": false }, "maxReviewsPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "When reviews are included, cap how many are fetched per product.", "default": 20 }, "reviewSort": { "title": "Review sort order", "enum": [ "submissiontime:desc", "submissiontime:asc", "rating:desc", "rating:asc", "helpfulness:desc" ], "type": "string", "description": "Order in which reviews are collected.", "default": "submissiontime:desc" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Egress proxy. BIG W's API works from most connections; the default Apify Proxy provides a stable IP. Choose Australian residential if you see soft blocks.", "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 } } }, "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 } } } } } } } } } }