# Flipp & Raddar (`canadesk/flyersca`) Actor

Extract Canadian flyer offers, prices, and promotion dates from Flipp and Raddar.

- **URL**: https://apify.com/canadesk/flyersca.md
- **Developed by:** [Canadesk Support](https://apify.com/canadesk) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per event

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

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

Collect Canadian flyer offers from **Flipp and Raddar**. Search one keyword or a list for a postal code, choose either provider or both, and download structured results.

### Features

| **Process** | **What you get** |
| :--- | :--- |
| Flipp search | Matching flyer and clearly identified e-commerce offers |
| Raddar search | Matching offers from nearby stores and their flyer publications |
| Flipp flyer | Items from a specific Flipp flyer ID |

Results include available names, retailers, prices, images and promotion dates. With both providers selected, Flipp runs first and Raddar uses the remaining result capacity.

### Pricing

Each valid run includes a shared minimum charge of 100 results. Missing rows are clearly marked placeholders and contain no source data.

Where listed in the Pricing tab, a handled lookup problem that prevents a run from returning any real results produces one clear error record and a single $0.02 unsuccessful-lookup fee, in addition to any listed start fee.

### Multiple inputs

Use `queries` to collect records from several inputs in one run. The 100-result minimum applies once to the whole run. `maxResults` is shared across the batch; use `maxResultsPerInput` to limit each input. Inputs are processed in order, and repeated records are returned once.

### Coverage

Each run uses one postal code. Raddar uses the selected search radius. Flipp search returns one source response and may omit other available offers. Offers from different providers stay separate; multi-buy prices retain their original text.

# Actor input Schema

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

With both selected, Flipp runs first and Raddar fills remaining result capacity.

## `queries` (type: `array`):

Optional list of up to 100 inputs in one run. Replaces the single input and selects its corresponding operation. Use only one batch list.

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

Product search text, up to 100 characters. Required unless collecting a Flipp flyer by ID.

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

Postal code used to find local offers.

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

Optional numeric flyer ID. Select Flipp alone to collect this flyer's items.

## `maxResults` (type: `integer`):

Maximum real records across the entire run, shared by all inputs.

## `maxResultsPerInput` (type: `integer`):

Optional limit per batch input, within the run-wide Maximum results limit. Inputs are processed in order.

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

Language of the source search.

## `radiusKm` (type: `integer`):

Search distance used for Raddar stores and publications.

## `pageSize` (type: `integer`):

Number of offers requested on each Raddar page.

## `page` (type: `integer`):

Zero-based starting page for Raddar.

## `maxPages` (type: `integer`):

Maximum number of Raddar pages to collect. Flipp has no exposed search-page cursor.

## `proxy` (type: `object`):

Optional proxy for source requests.

## Actor input object example

```json
{
  "provider": "both",
  "query": "milk",
  "postalCode": "M5V3L9",
  "maxResults": 10,
  "locale": "en",
  "radiusKm": 50,
  "pageSize": 50,
  "page": 0,
  "maxPages": 1
}
```

# Actor output Schema

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

No description

# 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 = {
    "provider": "both",
    "query": "milk",
    "postalCode": "M5V3L9",
    "maxResults": 10,
    "locale": "en",
    "maxPages": 1
};

// Run the Actor and wait for it to finish
const run = await client.actor("canadesk/flyersca").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 = {
    "provider": "both",
    "query": "milk",
    "postalCode": "M5V3L9",
    "maxResults": 10,
    "locale": "en",
    "maxPages": 1,
}

# Run the Actor and wait for it to finish
run = client.actor("canadesk/flyersca").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 '{
  "provider": "both",
  "query": "milk",
  "postalCode": "M5V3L9",
  "maxResults": 10,
  "locale": "en",
  "maxPages": 1
}' |
apify call canadesk/flyersca --silent --output-dataset

```

## MCP server setup

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

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/W7JalWlKHoyZfYkVf/builds/o1GZK5B33vynUWBCb/openapi.json