{ "openapi": "3.0.1", "info": { "title": "Flipp Grocery Deals Scraper", "description": "Scrape real store-level weekly-ad prices near any US or Canadian postal code - Kroger, Publix, ALDI, Walmart, Target, Costco, CVS, Walgreens and dozens more retailers. Search by product keyword or browse all active flyers for an area. No login, no API key.", "version": "1.0", "x-build-id": "kepyKEnzegM7rhe2e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~flipp-grocery-deals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-flipp-grocery-deals-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/crawlerbros~flipp-grocery-deals-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-flipp-grocery-deals-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/crawlerbros~flipp-grocery-deals-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-flipp-grocery-deals-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", "required": [ "mode", "postalCode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "flyers", "flyerItems", "merchants" ], "type": "string", "description": "What to fetch.", "default": "search" }, "postalCode": { "title": "Postal / ZIP code", "type": "string", "description": "A US ZIP code (e.g. `45202`) or Canadian postal code (e.g. `K1A 0B1`). Determines which stores' flyers/prices are searched. Not used for mode=flyerItems or mode=merchants.", "default": "45202" }, "query": { "title": "Search query (mode=search)", "type": "string", "description": "Product keyword, e.g. `milk`, `chicken breast`, `paper towels`.", "default": "milk" }, "itemType": { "title": "Item type (mode=search)", "enum": [ "all", "flyer", "ecom" ], "type": "string", "description": "Filter to weekly-ad flyer items (in-store circular pricing), online/e-commerce items, or both.", "default": "all" }, "sortBy": { "title": "Sort by (mode=search)", "enum": [ "relevancy", "price_low_to_high", "price_high_to_low" ], "type": "string", "description": "Order search results before filtering.", "default": "relevancy" }, "merchantName": { "title": "Merchant filter", "type": "string", "description": "Only keep results from a merchant whose name contains this text, e.g. `Kroger`, `Publix`, `ALDI`, `Walmart`, `Costco`, `CVS`. Also applies in mode=merchants." }, "category": { "title": "Category filter", "type": "string", "description": "Only keep results whose category/subcategory contains this text, e.g. `Beverages`, `Meat`, `Dairy`." }, "flyerIds": { "title": "Flyer IDs (mode=flyerItems)", "type": "array", "description": "Numeric flyer IDs to list every item from, e.g. `8041414`. Get IDs from the `flyerId` field of `search`/`flyers` mode output, or from a flyer URL like `flipp.com/en-us/flyer/8041414`.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop items priced below this (USD/CAD)." }, "maxPrice": { "title": "Max price", "minimum": 0, "maximum": 100000, "type": "number", "description": "Drop items priced above this (USD/CAD)." }, "includeRelatedItems": { "title": "Include related items (mode=search)", "type": "boolean", "description": "Also emit Flipp's 'related items' (cross-sell/adjacent product suggestions returned alongside some search results, e.g. searching `iphone` surfaces related phone-plan or accessory deals). Off by default since most queries return none.", "default": false }, "includeCoupons": { "title": "Include digital coupons (mode=search)", "type": "boolean", "description": "Also emit real digital-coupon offers (savings text, disclaimer, matched product) surfaced alongside search results for that postal code, e.g. `$2.00 off Tyson`. Off by default since not every query surfaces coupons.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 40 } } }, "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 } } } } } } } } } }