# Groupon Scraper (`ruocco-l/groupon-scraper`)

Scrape Groupon to find the latest offers on your favorite activities and products!

- **URL**: https://beta-securitybyobscurity.apify.com/ruocco-l/groupon-scraper.md
- **Developed by:** [Luigi Ruocco](https://beta-securitybyobscurity.apify.com/ruocco-l) (community)
- **Categories:** E-commerce, Travel
- **Stats:** 33 total users, 6 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

# README

### What does the Groupon Scraper do?

This Actor allows you to scrape information about products listed on [Groupon](https://www.groupon.com/).

### How to scrape Groupon?

Much like the Groupon website itself, you can select a keyword to search in a specific location.

This scraper enhance your searching possibilities by allowing you to search for multiple keywords at the same time in a specific location.

> 📝 **Note:** The location are restricted to US and Canada.

### Sample Output

```
{
        "uuid": "c109e449-c692-4b47-ae5d-0437e4f244a5",
        "url": "https://www.groupon.com/deals/science-world-4",
        "title": "Up to 15% Off General Admission Ticket to Science World!",
        "currencySymbol": "C$",
        "currencyCode": "CAD",
        "originalPrice": 24.83,
        "currentPrice": 21,
        "discountPercentage": 15,
        "productRating": 4.6,
        "productRatingsCount": 915,
        "hasLimitedSaleEnabled": true,
        "limitedSalePrice": 18.06,
        "promoCode": "EARLYBIRD24",
        "promoExpirationDate": "2024-11-22T23:59:00-08:00",
        "badges": [
            "Top Seller",
            "Trending",
            "Popular Gift",
            "Black Friday"
        ],
        "image": "https://img.grouponcdn.com/deal/4cdzbHXM9LbKSrZUfzcRwjAsNM5/4c-1920x1152/v1/t300x182.webp",
        "merchantName": "Science World",
        "merchantRating": null,
        "locationAddress": "1455 Quebec Street, Vancouver",
        "locationCoordinates": "49.273376, 49.273376",
        "input": {
            "keyword": "family",
            "location": "vancouver, canada"
        }
    },
```

### Your Feedback

We are constantly working on improving performance of our Actors and delivering more useful data for you. If you have a technical feedback or would like to see some improvement on the scraper, please create an issue on the Acotr's [Issues tab](https://console.apify.com/actors/oB6jaCJ4wV9xNRh4O/issues).

# Actor input Schema

## `keywords` (type: `array`):

Keyword to search

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

Specify a location, possibly in a "Zipcode, Neighborhood, City" format. Your results will depend on the location.

## `maxProductsPerSearch` (type: `integer`):

Use this input to limit the number of returned products per search.

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

You can specify the sorting method for the searches. It defaults to Relevance.

## Actor input object example

```json
{
  "keywords": [
    "family"
  ],
  "location": "90210, Trousdale Estates, Beverly Hills",
  "maxProductsPerSearch": 100,
  "sortMethod": "relevance"
}
```

# 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 = {
    "keywords": [
        "family"
    ],
    "location": "90210, Trousdale Estates, Beverly Hills"
};

// Run the Actor and wait for it to finish
const run = await client.actor("ruocco-l/groupon-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 = {
    "keywords": ["family"],
    "location": "90210, Trousdale Estates, Beverly Hills",
}

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

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

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

```

## CLI example

```bash
echo '{
  "keywords": [
    "family"
  ],
  "location": "90210, Trousdale Estates, Beverly Hills"
}' |
apify call ruocco-l/groupon-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=ruocco-l/groupon-scraper",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Groupon Scraper",
        "description": "Scrape Groupon to find the latest offers on your favorite activities and products!",
        "version": "0.0",
        "x-build-id": "qFcw1bKltd9dn2OO1"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/ruocco-l~groupon-scraper/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-ruocco-l-groupon-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/ruocco-l~groupon-scraper/runs": {
            "post": {
                "operationId": "runs-sync-ruocco-l-groupon-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/ruocco-l~groupon-scraper/run-sync": {
            "post": {
                "operationId": "run-sync-ruocco-l-groupon-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": [
                    "keywords",
                    "location"
                ],
                "properties": {
                    "keywords": {
                        "title": "Starting keyword",
                        "type": "array",
                        "description": "Keyword to search",
                        "items": {
                            "type": "string"
                        }
                    },
                    "location": {
                        "title": "Location to scrape",
                        "type": "string",
                        "description": "Specify a location, possibly in a \"Zipcode, Neighborhood, City\" format. Your results will depend on the location."
                    },
                    "maxProductsPerSearch": {
                        "title": "Max Number of Products to be scraped per search",
                        "minimum": 1,
                        "type": "integer",
                        "description": "Use this input to limit the number of returned products per search.",
                        "default": 100
                    },
                    "sortMethod": {
                        "title": "Sort method",
                        "enum": [
                            "relevance",
                            "price:asc",
                            "price:desc",
                            "distance",
                            "rating"
                        ],
                        "type": "string",
                        "description": "You can specify the sorting method for the searches. It defaults to Relevance.",
                        "default": "relevance"
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
