# Grocery Deals & Flyer Scraper for Flipp (US & Canada) (`haketa/flipp-scraper`) Actor

Scrape grocery flyer and online deals from Flipp by search term and location: item name, current & original price, discount, sale story, merchant, validity and image. For price tracking, deal research and comparison. Independent tool, not affiliated with Flipp.

- **URL**: https://apify.com/haketa/flipp-scraper.md
- **Developed by:** [Haketa](https://apify.com/haketa) (community)
- **Categories:** E-commerce, Other
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Grocery Deals & Flyer Scraper for Flipp (US & Canada)

> **Extract grocery flyer & online deals from Flipp at scale: item name, current & original price, discount, sale story, merchant, validity dates and image.** Search by product/category and postal code and get clean JSON/CSV/Excel in seconds. Built for price tracking, deal aggregation, comparison and market research.

[![Deals](https://img.shields.io/badge/Flipp-Grocery%20Deals-e01a2b)]()
[![Price & Discount](https://img.shields.io/badge/Price%20%2B%20Discount%20%2B%20Merchant-2da44e)]()
[![US & Canada](https://img.shields.io/badge/US%20%2B%20Canada-blue)]()
[![Export](https://img.shields.io/badge/Export-JSON%20%2F%20CSV%20%2F%20Excel-fb8500)]()

***

### What This Actor Does

**Flipp** aggregates weekly grocery flyers and online deals from thousands of US & Canadian retailers. This Actor turns a product search into a structured deals dataset. For each deal it returns:

- **Item** — name, weight/size, image
- **Pricing** — current price, original price, discount % and the sale story (e.g. "SAVE 46%")
- **Merchant** — store name, logo, flyer ID
- **Validity** — deal start and end dates
- **Online extras** — SKU, rating, review count and shipping (for e-commerce deals)

Search one or many terms for a postal/ZIP code and it returns matching flyer and online deals, deduped.

***

### Why Use This

- **Local grocery prices & discounts.** Real, current deals for a ZIP/postal code across many stores — perfect for price tracking and comparison.
- **Flyer + online in one.** Printed weekly-flyer deals and online/e-commerce deals together, each tagged by type.
- **Discount intelligence.** Current vs original price, discount % and sale story make it easy to rank the best deals.
- **Fast and clean.** Reads Flipp's own public API — no anti-bot, no browser, no proxy needed.

***

### Quick Start

#### Run it in the console (no code)

1. Add **Search terms** (e.g. `milk`, `eggs`, `coffee`).
2. Enter a **Postal / ZIP code** (US ZIP like `10001` or Canadian like `M5V2T6`) and pick the **Locale**.
3. Click **Start**, then export as **JSON, CSV, Excel or HTML**, or push to Google Sheets, a webhook or a database.

#### Run it via API (Python)

```python
from apify_client import ApifyClient

client = ApifyClient("YOUR_APIFY_TOKEN")

run_input = {
    "searchTerms": ["milk", "eggs", "coffee"],
    "postalCode": "10001",
    "locale": "en-us",
}

run = client.actor("YOUR_USERNAME/flipp-scraper").call(run_input=run_input)

for d in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(d["name"], "·", d["currentPrice"], "·", d["merchant"], "·", d.get("saleStory"))
```

#### Find the cheapest option per term (Python)

```python
run = client.actor("YOUR_USERNAME/flipp-scraper").call(run_input={
    "searchTerms": ["chicken breast"], "postalCode": "60601",
})
best = {}
for d in client.dataset(run["defaultDatasetId"]).iterate_items():
    if d.get("currentPrice") is not None:
        key = d["searchTerm"]
        if key not in best or d["currentPrice"] < best[key]["currentPrice"]:
            best[key] = d
for term, d in best.items():
    print(term, "→", d["merchant"], d["currentPrice"])
```

***

### Input Parameters

| Field | Type | Description |
|---|---|---|
| `searchTerms` | array | Products/categories to search (e.g. `milk`, `eggs`). |
| `postalCode` | string | US ZIP or Canadian postal code for local flyers. |
| `locale` | string | `en-us` or `en-ca`. |
| `includeEcom` | boolean | Also include online/e-commerce deals. Default `true`. |
| `maxItems` | integer | Max deals across all terms. `0` = no limit. |
| `proxyConfiguration` | object | Apify Proxy. Datacenter is enough and enabled by default. |

***

### Output

Each deal is one record:

```json
{
  "type": "flyer",
  "name": "Eclipse Non-Dairy Whole Milk",
  "currentPrice": 2.99,
  "originalPrice": 5.49,
  "discountPercent": 46,
  "saleStory": "SAVE 46%",
  "itemWeight": "64 oz",
  "merchant": "Food Bazaar Supermarket",
  "flyerId": "8141393",
  "validFrom": "2026-09-24T04:00:00+00:00",
  "validTo": "2026-10-01T03:59:59+00:00",
  "imageUrl": "https://f.wishabi.net/page_items/....jpg",
  "searchTerm": "milk",
  "postalCode": "10001"
}
```

Online deals (`type: "online"`) additionally include `sku`, `averageRating`, `totalReviews` and `shippingInfo`.

***

### Use Cases

#### 1. Grocery price tracking

Track current prices and discounts for products across local stores over time — a base for price-monitoring apps and dashboards.

#### 2. Deal aggregation & comparison

Aggregate the best weekly deals by product and merchant for a ZIP code — power a savings/comparison site or newsletter.

#### 3. Competitive & pricing intelligence

Compare how retailers price and discount the same products in a market.

#### 4. Market & CPG research

Analyze promotions, discount depth and merchant activity by category and region.

#### 5. Personal savings automation

Feed deals into a shopping-list or budget tool to surface the cheapest options near you.

***

### Tips

- **More terms = more coverage.** Add several products/categories; results are deduped across terms.
- **Locale must match the code:** use `en-us` with US ZIPs and `en-ca` with Canadian postal codes.
- **`type`** tells flyer (printed weekly-ad) from online (e-commerce) deals.
- **Schedule it** with Apify Schedules to track weekly-flyer prices over time.

***

### Frequently Asked Questions

**Do I need an account?**
No. The Actor reads publicly available deal data — no login required.

**Which countries are covered?**
United States (`en-us`) and Canada (`en-ca`) — set the locale to match your postal code.

**Why do some flyer items lack a price?**
Printed-flyer entries are sometimes image-only; this Actor keeps named deals and includes clean online deals with full pricing.

**What export formats are supported?**
JSON, CSV, Excel, HTML, or via API — plus Google Sheets, webhooks, Make and Zapier.

***

### Legal & Responsible Use

This Actor is an independent tool and is **not affiliated with, endorsed by, or sponsored by Flipp** or any retailer. All trademarks are the property of their respective owners.

It collects only publicly available deal information for research and personal use. You are responsible for how you use the data. Please:

- Respect Flipp's Terms of Service and applicable laws.
- Do not use the data for spam or any unlawful purpose.
- Use reasonable request volumes and scheduling.

# Actor input Schema

## `searchTerms` (type: `array`):

Products or categories to search (e.g. milk, eggs, coffee, chicken, cereal). Each term returns matching deals.

## `postalCode` (type: `string`):

US ZIP (e.g. 10001) or Canadian postal code (e.g. M5V2T6) for local flyers.

## `locale` (type: `string`):

en-us (United States) or en-ca (Canada).

## `includeEcom` (type: `boolean`):

Also include online/e-commerce deals (with rating, SKU, shipping) alongside printed flyer deals.

## `maxItems` (type: `integer`):

Maximum deals across all search terms. 0 = no limit.

## `proxyConfiguration` (type: `object`):

Apify Proxy. Datacenter is enough for Flipp and is enabled by default.

## Actor input object example

```json
{
  "searchTerms": [
    "milk",
    "eggs",
    "coffee"
  ],
  "postalCode": "10001",
  "locale": "en-us",
  "includeEcom": true,
  "maxItems": 100,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

# Actor output Schema

## `type` (type: `string`):

flyer | online

## `itemId` (type: `string`):

Deal item ID

## `name` (type: `string`):

Item name

## `currentPrice` (type: `string`):

Sale/current price

## `originalPrice` (type: `string`):

Original price

## `discountPercent` (type: `string`):

Discount percent

## `saleStory` (type: `string`):

Deal text (e.g. SAVE 46%)

## `prePriceText` (type: `string`):

Text before price

## `postPriceText` (type: `string`):

Text after price

## `itemWeight` (type: `string`):

Item weight/size

## `merchant` (type: `string`):

Store/merchant

## `merchantLogo` (type: `string`):

Merchant logo URL

## `flyerId` (type: `string`):

Flyer ID

## `validFrom` (type: `string`):

Deal start date

## `validTo` (type: `string`):

Deal end date

## `description` (type: `string`):

Item description (online)

## `sku` (type: `string`):

SKU (online)

## `averageRating` (type: `string`):

Average rating (online)

## `totalReviews` (type: `string`):

Review count (online)

## `shippingInfo` (type: `string`):

Shipping info (online)

## `imageUrl` (type: `string`):

Item image URL

## `searchTerm` (type: `string`):

Search term

## `postalCode` (type: `string`):

Postal/ZIP searched

## `scrapedAt` (type: `string`):

ISO timestamp

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "searchTerms": [
        "milk",
        "eggs",
        "coffee"
    ],
    "postalCode": "10001",
    "locale": "en-us",
    "includeEcom": true,
    "maxItems": 100,
    "proxyConfiguration": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("haketa/flipp-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "searchTerms": [
        "milk",
        "eggs",
        "coffee",
    ],
    "postalCode": "10001",
    "locale": "en-us",
    "includeEcom": True,
    "maxItems": 100,
    "proxyConfiguration": { "useApifyProxy": True },
}

# Run the Actor and wait for it to finish
run = client.actor("haketa/flipp-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "searchTerms": [
    "milk",
    "eggs",
    "coffee"
  ],
  "postalCode": "10001",
  "locale": "en-us",
  "includeEcom": true,
  "maxItems": 100,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}' |
apify call haketa/flipp-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,haketa/flipp-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/RUrV5i5Ei1QcJQ9gu/builds/F5Esb1IR7buTAV2c7/openapi.json