{ "openapi": "3.0.1", "info": { "title": "Québec Grocery Flyers — Maxi, Metro, IGA, Adonis, Kim Phat", "description": "Weekly flyer prices from Québec grocery stores: Maxi, Metro, Super C, IGA, Provigo, Adonis, Kim Phat, Avril, Marché Tradition and 40+ more. Product, brand, size, price, discount, validity dates and image for any postal code. Export JSON/CSV/Excel.", "version": "1.0", "x-build-id": "tNsKXnCwCDHqcflDF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ocrad~quebec-grocery-flyers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ocrad-quebec-grocery-flyers-scraper", "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/ocrad~quebec-grocery-flyers-scraper/runs": { "post": { "operationId": "runs-sync-ocrad-quebec-grocery-flyers-scraper", "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/ocrad~quebec-grocery-flyers-scraper/run-sync": { "post": { "operationId": "run-sync-ocrad-quebec-grocery-flyers-scraper", "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": { "stores": { "title": "Stores", "type": "array", "description": "Grocery stores to scrape. Leave empty for every grocery flyer at the postal code (about 45 stores in Montréal).", "items": { "type": "string", "enum": [ "Maxi", "Metro", "Super C", "IGA", "Provigo", "Adonis", "Kim Phat", "Avril", "Marché Tradition", "Marché Richelieu", "Marché Bonichoix", "Rachelle Béry", "Mayrand", "L'Inter-Marché", "Supermarché PA", "Marchés TAU", "T&T", "Walmart", "Tigre Géant", "Club Entrepôt", "Voilà (IGA)" ] }, "default": [] }, "postalCode": { "title": "Postal code", "pattern": "^[A-Za-z][0-9][A-Za-z][ -]?[0-9][A-Za-z][0-9]$", "type": "string", "description": "Postal code the flyers are looked up for, e.g. H2X 1Y4 (Montréal), G1R 4P5 (Québec City), J4K 2T4 (Longueuil). Flyers and stores differ by region.", "default": "H2X1Y4" }, "keyword": { "title": "Keyword", "type": "string", "description": "Optional. Keep only items whose name or brand contains this word, accent- and case-insensitive, e.g. lait, poulet, café." }, "locale": { "title": "Language", "enum": [ "fr-ca", "en-ca" ], "type": "string", "description": "Language of the flyer catalogue. Most Québec flyers are bilingual either way; titleFr and titleEn are split when the name holds both.", "default": "fr-ca" }, "maxItems": { "title": "Max items", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum number of flyer items to return (0 = all). One supermarket flyer holds about 150-600 items.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Defaults to Apify Proxy (auto). Switch to a RESIDENTIAL group if you see blocks or empty results.", "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 }, "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 } } } } } } } } } }