{ "openapi": "3.0.1", "info": { "title": "Australia Catalogue Specials - Weekly Deals by State", "description": "Current catalogue specials from Australian retailers (Woolworths, Coles, IGA, Kmart, Target, Bunnings, Priceline, Myer and more) by state. Prices, multi-buy offers, savings and validity dates in one clean schema.", "version": "1.0", "x-build-id": "UzO7WJ1nG8HHMupWe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gratifying_graph~australia-catalogue-specials/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gratifying_graph-australia-catalogue-specials", "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/gratifying_graph~australia-catalogue-specials/runs": { "post": { "operationId": "runs-sync-gratifying_graph-australia-catalogue-specials", "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/gratifying_graph~australia-catalogue-specials/run-sync": { "post": { "operationId": "run-sync-gratifying_graph-australia-catalogue-specials", "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", "required": [ "state" ], "properties": { "state": { "title": "State or territory", "enum": [ "NSW", "VIC", "QLD", "WA", "SA", "TAS", "ACT", "NT" ], "type": "string", "description": "Catalogues differ by state. The actor reads the catalogues Salefinder shows for the state capital (Sydney, Melbourne, Brisbane, Perth, Adelaide, Hobart, Canberra, Darwin)." }, "retailers": { "title": "Retailers", "type": "array", "description": "Only read catalogues from these retailers (e.g. Woolworths, Coles, Kmart, Dan Murphy's). Case and punctuation do not matter. With several retailers, maxItems is shared evenly between them. Empty = every retailer with a current catalogue in the state.", "default": [], "items": { "type": "string" } }, "queries": { "title": "Search terms", "type": "array", "description": "Keep only items whose name contains every word of a term (e.g. coffee, chocolate, nappies). Words match the start of a word in the name, so egg finds Eggs. Empty = every item in the matching catalogues.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max deals", "minimum": 1, "type": "integer", "description": "Cap on the number of deal records for the whole run. You pay per record, so a small cap keeps a test run cheap.", "default": 200 }, "onlyWithPrice": { "title": "Only deals with a numeric price", "type": "boolean", "description": "Skip catalogue items that show no price (e.g. \"35% off selected products\" promos).", "default": true }, "includeOldCatalogues": { "title": "Include old range catalogues", "type": "boolean", "description": "Salefinder keeps some range catalogues listed for years (for example office and hardware books from past seasons). By default the actor skips catalogues that started more than 60 days ago.", "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 } } } } } } } } } }