{ "openapi": "3.0.1", "info": { "title": "BasketWatch Irish Grocery Data - Aldi|Tesco|SuperValu|Dunnes", "description": "Weekly product, price, unit price and promotion data for the four major Irish supermarkets. Thin client — fetches from BasketWatch's existing API (so prices are the same weekly snapshot as the BasketWatch dashboard, no scraping happens at run-time).", "version": "0.4", "x-build-id": "XRQqgKHlO18ev1XnN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hawkish_gym~basketwatch-irish-grocery-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hawkish_gym-basketwatch-irish-grocery-data", "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/hawkish_gym~basketwatch-irish-grocery-data/runs": { "post": { "operationId": "runs-sync-hawkish_gym-basketwatch-irish-grocery-data", "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/hawkish_gym~basketwatch-irish-grocery-data/run-sync": { "post": { "operationId": "run-sync-hawkish_gym-basketwatch-irish-grocery-data", "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": [ "store", "dataset" ], "properties": { "store": { "title": "Retailer", "enum": [ "aldi", "tesco", "supervalu", "dunnes" ], "type": "string", "description": "Which Irish supermarket to pull data from.", "default": "aldi" }, "dataset": { "title": "Dataset", "enum": [ "products", "promotions", "new-products", "removed", "changes" ], "type": "string", "description": "What kind of data to pull.\n\n- **products** — full product catalogue: SKU, name, brand, pack size, current price, unit price, category.\n- **promotions** — only products currently on offer (multibuy, clubcard, savings, was-prices). SuperValu / Tesco / Dunnes only.\n- **new-products** — products newly listed within the lookback window.\n- **removed** — products that have dropped off the catalogue within the lookback window.\n- **changes** — price moves between the latest weekly snapshot and the previous one (delta + % change).", "default": "products" }, "max_products": { "title": "Maximum rows to return", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on dataset size. 500 is plenty to evaluate the data; a single retailer's full catalogue runs 3,000-20,000 rows. Set higher (up to 100,000) for full multi-store pulls. Pay-per-result pricing means cost scales linearly with this number — check the cost estimate before starting.", "default": 500 }, "search": { "title": "Filter by product name (optional)", "type": "string", "description": "Case-insensitive substring match on the product name. Example: 'heinz' returns only Heinz products. Only applied when dataset = 'products'." }, "days_back": { "title": "Lookback window (days)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Only used for 'new-products' and 'removed'. How many days back to look from today. Since scrapes run weekly, a value of 7 captures everything since the last snapshot; 14 captures the prior two weeks, etc.", "default": 7 } } }, "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 } } } } } } } } } }