{ "openapi": "3.0.1", "info": { "title": "Canadian Grocery Price Comparison Scraper API", "description": "Compare grocery prices across Loblaws, Superstore, No Frills, Save-On-Foods, PriceSmart, and T&T from one input. Get normalized product matches, prices, unit prices, sale flags, store details, product URLs, and CSV/JSON/Excel-ready output for apps, AI agents, and research.", "version": "1.0", "x-build-id": "wwRDc6LwrDXIGpvIq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sunny_eternity~canada-grocery-price-comparison/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sunny_eternity-canada-grocery-price-comparison", "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/sunny_eternity~canada-grocery-price-comparison/runs": { "post": { "operationId": "runs-sync-sunny_eternity-canada-grocery-price-comparison", "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/sunny_eternity~canada-grocery-price-comparison/run-sync": { "post": { "operationId": "run-sync-sunny_eternity-canada-grocery-price-comparison", "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": { "queries": { "title": "Grocery Queries", "type": "array", "description": "Item names to look up across retailers (e.g. ['ground beef', 'eggs', 'celery']). Required for comparison/summary/intel output modes.", "items": { "type": "string" } }, "retailers": { "title": "Retailers", "type": "array", "description": "Which Canadian grocery retailers to compare. Defaults to all six.", "items": { "type": "string", "enum": [ "tnt", "loblaws", "superstore", "nofrills", "saveonfoods", "pricesmart" ], "enumTitles": [ "T&T Supermarket", "Loblaws", "Real Canadian Superstore", "No Frills", "Save-On-Foods", "PriceSmart Foods" ] }, "default": [ "tnt", "loblaws", "superstore", "nofrills", "saveonfoods", "pricesmart" ] }, "region": { "title": "Region", "enum": [ "metro_vancouver", "metro_calgary", "metro_edmonton", "metro_toronto", "metro_ottawa", "metro_montreal", "metro_quebec_city", "metro_halifax" ], "type": "string", "description": "Canadian metropolitan region — maps to a representative postal code for location-aware pricing. Use 'postal_code' for a specific address.", "default": "metro_vancouver" }, "postal_code": { "title": "Postal Code (optional override)", "pattern": "^[A-Za-z]\\d[A-Za-z]\\s?\\d[A-Za-z]\\d$", "type": "string", "description": "Canadian postal code (e.g. 'V5X 0C4'). Overrides 'region' if provided." }, "locationIds": { "title": "Per-Retailer Store ID Overrides (optional)", "type": "object", "description": "Optional per-retailer store ID overrides (e.g. {\"tnt\": \"MGFS\", \"superstore\": \"1517\", \"saveonfoods\": \"1982\"}). Takes priority over region/postal_code for that retailer.", "additionalProperties": true }, "categories": { "title": "Categories (category_browse / intel modes only)", "type": "array", "description": "Unified category slugs to browse (e.g. ['produce', 'dairy-eggs', 'meat']). Used only when outputMode is 'category_browse' or 'intel'.", "items": { "type": "string", "enum": [ "produce", "dairy-eggs", "meat", "seafood", "bakery", "frozen", "pantry", "snacks", "beverages", "international", "deli", "prepared-meals", "plant-based", "health-beauty", "baby-care", "pet-care", "household" ], "enumTitles": [ "Produce (Fruits & Vegetables)", "Dairy & Eggs", "Meat", "Fish & Seafood", "Bakery", "Frozen Foods", "Pantry & Dry Goods", "Snacks, Chips & Candy", "Beverages", "International Foods", "Deli", "Prepared Meals", "Plant-Based & Non-Dairy", "Health & Beauty", "Baby Care", "Pet Care", "Household & Cleaning" ] } }, "maxResultsPerQueryPerRetailer": { "title": "Max Results Per Query Per Retailer", "minimum": 1, "maximum": 50, "type": "integer", "description": "Cap on matched results returned per (query, retailer). Default 3.", "default": 3 }, "retailerConcurrency": { "title": "Retailer Concurrency", "minimum": 1, "maximum": 6, "type": "integer", "description": "How many retailers to scrape in parallel. Default 3.", "default": 3 }, "minMatchConfidence": { "title": "Minimum Match Confidence", "enum": [ "low", "medium", "high" ], "type": "string", "description": "Drop results below this confidence floor. 'low' (loose), 'medium' (recommended), 'high' (strict, exact-match feel).", "default": "low" }, "outputMode": { "title": "Output Mode", "enum": [ "comparison", "comparison_grouped", "summary", "category_browse", "intel" ], "type": "string", "description": "comparison = flat rows per match; comparison_grouped = one record per query; summary = cheapest/spread per query; category_browse = full per-retailer catalog browse; intel = products + summaries + category leaderboards (heaviest).", "default": "comparison" } } }, "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 } } } } } } } } } }