{ "openapi": "3.0.1", "info": { "title": "BIG W Deals & Price Tracker", "description": "Track BIG W (bigw.com.au) deals: specials, clearance, flash deals and price drops with current price, was-price, RRP, $ and % savings, promo badges and stock. Filter by deal type and minimum discount, sweep categories, or watch specific products. Clean JSON. Pay only for results.", "version": "1.0", "x-build-id": "PXebhu9Sh6kG6XvHD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~bigw-deals-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-bigw-deals-tracker", "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-deals-tracker/runs": { "post": { "operationId": "runs-sync-axlymxp-bigw-deals-tracker", "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-deals-tracker/run-sync": { "post": { "operationId": "run-sync-axlymxp-bigw-deals-tracker", "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": { "dealTypes": { "title": "Deal types", "type": "array", "description": "Which BIG W deal types to collect. Leave the defaults for the most common specials and clearance.", "items": { "type": "string", "enum": [ "Clearance", "Special", "Flash Deal", "Multi-Buy", "Lowest price in 14 days", "Lowest price in 7 days", "New" ], "enumTitles": [ "Clearance", "Special", "Flash Deal", "Multi-Buy", "Lowest price in 14 days", "Lowest price in 7 days", "New" ] }, "default": [ "Clearance", "Special", "Flash Deal" ] }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Only look for deals within these numeric category IDs (from a category URL: /.../c/, e.g. 68 = Toys). Leave empty to auto-sweep the top categories that currently have deals.", "default": [], "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Only look for deals matching these keywords.", "default": [], "items": { "type": "string" } }, "productCodes": { "title": "Watchlist product codes", "type": "array", "description": "Track specific products by article ID (or product URL). Their current price and deal status are always reported, even if not currently discounted.", "default": [], "items": { "type": "string" } }, "minDiscountPercent": { "title": "Minimum discount %", "minimum": 0, "maximum": 95, "type": "integer", "description": "Only keep deals with at least this percentage off the was-price / RRP.", "default": 0 }, "onlyInStock": { "title": "Only in-stock deals", "type": "boolean", "description": "Return only deals that are currently in stock.", "default": true }, "maxItems": { "title": "Max deals (total)", "minimum": 1, "type": "integer", "description": "Global cap on the number of deal rows pushed.", "default": 500 }, "maxPagesPerQuery": { "title": "Max pages per query", "minimum": 1, "maximum": 42, "type": "integer", "description": "Pages per category/keyword (48 results per page). BIG W caps any single query at 2000 results.", "default": 20 }, "sort": { "title": "Sort order", "enum": [ "relevance", "priceAsc", "priceDesc", "nameAsc", "nameDesc" ], "type": "string", "description": "Result ordering within each query.", "default": "priceDesc" }, "includeReviewStats": { "title": "Include rating summary", "type": "boolean", "description": "Also fetch each product's average rating and review count. One extra request per deal.", "default": false }, "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 } } } } } } } } } }