{ "openapi": "3.0.1", "info": { "title": "Canada Grocery Deals - Flyer Prices by Postal Code", "description": "Current flyer deals from Canadian grocery chains (Loblaws, Metro, Sobeys, IGA, Walmart, Super C, Maxi and more) for any postal code. Search by product, compare prices across chains, track deals on a schedule. EN + FR.", "version": "1.0", "x-build-id": "GIhbkOBWDhlMDNcbH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gratifying_graph~canada-grocery-deals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gratifying_graph-canada-grocery-deals", "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~canada-grocery-deals/runs": { "post": { "operationId": "runs-sync-gratifying_graph-canada-grocery-deals", "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~canada-grocery-deals/run-sync": { "post": { "operationId": "run-sync-gratifying_graph-canada-grocery-deals", "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": [ "postalCode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "flyers" ], "type": "string", "description": "search: find deals for your search terms (default). flyers: every item of every flyer near the postal code, filtered by flyer category.", "default": "search" }, "postalCode": { "title": "Postal code", "type": "string", "description": "Canadian postal code (e.g. H2X 1Y6). Deals are local: flyers differ by region. Invalid codes are rejected before any charge." }, "queries": { "title": "Search terms", "type": "array", "description": "Products to search for (e.g. chicken, milk, diapers). One search per term. Required in search mode. In flyers mode, optional: only items whose name or brand contains a term are kept.", "items": { "type": "string" } }, "merchants": { "title": "Merchant filter", "type": "array", "description": "Only include these chains (case-insensitive substring, punctuation ignored, e.g. Metro, IGA, Maxi). Empty = all chains. Works in both modes.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Flyer categories (flyers mode)", "type": "array", "description": "Flyers mode only. Keep flyers in these Flipp categories: Groceries, Pharmacy, Home & Garden, General Merchandise, Pets, Electronics, Specialty, Sporting Goods, Automotive, Fashion, Baby & Kids, Office, Restaurants. Empty = all categories.", "default": [ "Groceries" ], "items": { "type": "string" } }, "locale": { "title": "Language", "enum": [ "en-ca", "fr-ca" ], "type": "string", "description": "Flyer language. en-ca for English Canada, fr-ca for French Canada.", "default": "en-ca" }, "maxItemsPerQuery": { "title": "Max deals per search term (search mode)", "minimum": 1, "maximum": 150, "type": "integer", "description": "Cap on the number of flyer deals returned per search term. The source returns at most 150 per term.", "default": 150 }, "maxItems": { "title": "Max items per run (flyers mode)", "minimum": 1, "type": "integer", "description": "Flyers mode only. Stops after this many items. A full city grocery sweep is several thousand items, so raise it on purpose.", "default": 200 }, "onlyWithPrice": { "title": "Only deals with a numeric price", "type": "boolean", "description": "Skip flyer items without a parseable price (e.g. image-only promos).", "default": 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 }, "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 } } } } } } } } } }